--- updatedAt: 2026-09-01T00:04:12.000Z agentTools: projectIndex: https://docs.leonardo.ai/llms.txt --- # Create Async Generation Submit a generation job. Returns a generation ID to poll for the finished result. # OpenAPI definition ```json { "x-generated-notice": "AUTO-GENERATED FILE — DO NOT EDIT DIRECTLY. Edit openapi-v2.template.json instead, then run: npm run generate:v2-models", "openapi": "3.0.0", "info": { "description": "Leonardo.Ai API OpenAPI specification v2.0", "title": "Rest Endpoints v2", "version": "v2.0.0" }, "servers": [ { "url": "https://cloud.leonardo.ai/api/rest/v2", "description": "Leonardo.Ai API server v2" } ], "tags": [ { "name": "Generations" } ], "paths": { "/generations": { "post": { "tags": [ "Generations" ], "summary": "Create Async Generation", "description": "Submit a generation job. Returns a generation ID to poll for the finished result.", "operationId": "createGeneration", "requestBody": { "content": { "application/json": { "schema": { "discriminator": { "propertyName": "model", "mapping": { "motion_2.0": "#/components/schemas/Motion2_0GenerationRequest", "motion_2.0-fast": "#/components/schemas/Motion2_0FastGenerationRequest", "veo-3.1-generate-001": "#/components/schemas/Veo3_1Generate001GenerationRequest", "veo-3.1-fast-generate-001": "#/components/schemas/Veo3_1FastGenerate001GenerationRequest", "veo-3.1-lite": "#/components/schemas/Veo3_1LiteGenerationRequest", "flux-dev": "#/components/schemas/FluxDevGenerationRequest", "flux-kontext-pro": "#/components/schemas/FluxKontextProGenerationRequest", "flux-kontext-max": "#/components/schemas/FluxKontextMaxGenerationRequest", "flux-schnell": "#/components/schemas/FluxSchnellGenerationRequest", "flux-pro-2.0": "#/components/schemas/FluxPro2_0GenerationRequest", "phoenix-v0.9": "#/components/schemas/PhoenixV0_9GenerationRequest", "phoenix-v1.0": "#/components/schemas/PhoenixV1_0GenerationRequest", "kino-xl": "#/components/schemas/KinoXlGenerationRequest", "anime-xl": "#/components/schemas/AnimeXlGenerationRequest", "portrait-perfect": "#/components/schemas/PortraitPerfectGenerationRequest", "stock-photography": "#/components/schemas/StockPhotographyGenerationRequest", "illustrative-albedo": "#/components/schemas/IllustrativeAlbedoGenerationRequest", "concept-art": "#/components/schemas/ConceptArtGenerationRequest", "lifelike-vision": "#/components/schemas/LifelikeVisionGenerationRequest", "graphic-design": "#/components/schemas/GraphicDesignGenerationRequest", "lightning-xl": "#/components/schemas/LightningXlGenerationRequest", "ideogram-v3.0": "#/components/schemas/IdeogramV3_0GenerationRequest", "ideogram-v4.0": "#/components/schemas/IdeogramV4_0GenerationRequest", "ideogram/p-image-ideogram": "#/components/schemas/Ideogram_pImageIdeogramGenerationRequest", "ideogram/ideogram-4.5": "#/components/schemas/Ideogram_ideogram4_5GenerationRequest", "gemini-2.5-flash-image": "#/components/schemas/Gemini2_5FlashImageGenerationRequest", "nano-banana-2": "#/components/schemas/NanoBanana2GenerationRequest", "google/nano-banana-2.1": "#/components/schemas/Google_nanoBanana2_1GenerationRequest", "nano-banana-2-lite": "#/components/schemas/NanoBanana2LiteGenerationRequest", "gemini-image-2": "#/components/schemas/GeminiImage2GenerationRequest", "kling-2.5": "#/components/schemas/Kling2_5GenerationRequest", "kling-2.6": "#/components/schemas/Kling2_6GenerationRequest", "kling-2.5-turbo-standard": "#/components/schemas/Kling2_5TurboStandardGenerationRequest", "lucid-origin": "#/components/schemas/LucidOriginGenerationRequest", "lucid-realism": "#/components/schemas/LucidRealismGenerationRequest", "ltxv-2.3-pro": "#/components/schemas/Ltxv2_3ProGenerationRequest", "ltxv-2.3-fast": "#/components/schemas/Ltxv2_3FastGenerationRequest", "happy-horse": "#/components/schemas/HappyHorseGenerationRequest", "happy-horse-1.1": "#/components/schemas/HappyHorse1_1GenerationRequest", "hailuo-2_3": "#/components/schemas/Hailuo23GenerationRequest", "hailuo-2_3-fast": "#/components/schemas/Hailuo23FastGenerationRequest", "hailuo-03": "#/components/schemas/Hailuo03GenerationRequest", "alibaba/wan-3.0": "#/components/schemas/Alibaba_wan3_0GenerationRequest", "wan-2.7": "#/components/schemas/Wan2_7GenerationRequest", "bfl/flux-3-video": "#/components/schemas/Bfl_flux3VideoGenerationRequest", "bfl/flux-3-image": "#/components/schemas/Bfl_flux3ImageGenerationRequest", "wan-2.6": "#/components/schemas/Wan2_6GenerationRequest", "seedance-1.0-pro": "#/components/schemas/Seedance1_0ProGenerationRequest", "seedance-1.0-pro-fast": "#/components/schemas/Seedance1_0ProFastGenerationRequest", "seedance-2.0": "#/components/schemas/Seedance2_0GenerationRequest", "seedance-2.0-fast": "#/components/schemas/Seedance2_0FastGenerationRequest", "seedance-2.0-mini": "#/components/schemas/Seedance2_0MiniGenerationRequest", "bytedance/seedance-2.5": "#/components/schemas/Bytedance_seedance2_5GenerationRequest", "bytedance/video-upscaler": "#/components/schemas/Bytedance_videoUpscalerGenerationRequest", "grok-imagine-1.5": "#/components/schemas/GrokImagine1_5GenerationRequest", "seedream-4.0": "#/components/schemas/Seedream4_0GenerationRequest", "seedream-4.5": "#/components/schemas/Seedream4_5GenerationRequest", "seedream-5.0-pro": "#/components/schemas/Seedream5_0ProGenerationRequest", "bytedance/seedream-5.0-flash": "#/components/schemas/Bytedance_seedream5_0FlashGenerationRequest", "gpt-image-1.5": "#/components/schemas/GptImage1_5GenerationRequest", "gpt-image-2": "#/components/schemas/GptImage2GenerationRequest", "openai/gpt-image-2.5-flare": "#/components/schemas/Openai_gptImage2_5FlareGenerationRequest", "openai/gpt-image-2.5-sunburst": "#/components/schemas/Openai_gptImage2_5SunburstGenerationRequest", "recraft-v4": "#/components/schemas/RecraftV4GenerationRequest", "recraft-v4-pro": "#/components/schemas/RecraftV4ProGenerationRequest", "krea-2-turbo": "#/components/schemas/Krea2TurboGenerationRequest", "krea/krea-3": "#/components/schemas/Krea_krea3GenerationRequest", "krea/krea-2": "#/components/schemas/Krea_krea2GenerationRequest", "kling-video-o-1": "#/components/schemas/KlingVideoO1GenerationRequest", "kling-3.0": "#/components/schemas/Kling3_0GenerationRequest", "kling-3.0-turbo": "#/components/schemas/Kling3_0TurboGenerationRequest", "gemini-omni-flash": "#/components/schemas/GeminiOmniFlashGenerationRequest", "google/gemini-omni-1.1-flash-preview": "#/components/schemas/Google_geminiOmni1_1FlashPreviewGenerationRequest", "kling-video-o-3": "#/components/schemas/KlingVideoO3GenerationRequest", "kling-4.0": "#/components/schemas/Kling4_0GenerationRequest", "aurora-upscaler-creative": "#/components/schemas/AuroraUpscalerCreativeGenerationRequest", "aurora-upscaler-precise": "#/components/schemas/AuroraUpscalerPreciseGenerationRequest", "remove-bg": "#/components/schemas/RemoveBgGenerationRequest", "rodin-v2": "#/components/schemas/RodinV2GenerationRequest", "meshy/meshy-7": "#/components/schemas/Meshy_meshy7GenerationRequest", "music-v1": "#/components/schemas/MusicV1GenerationRequest", "sound-effects-v2": "#/components/schemas/SoundEffectsV2GenerationRequest", "dialogue-v3": "#/components/schemas/DialogueV3GenerationRequest", "seed-audio-1.0": "#/components/schemas/SeedAudio1_0GenerationRequest" } }, "oneOf": [ { "$ref": "#/components/schemas/Motion2_0GenerationRequest" }, { "$ref": "#/components/schemas/Motion2_0FastGenerationRequest" }, { "$ref": "#/components/schemas/Veo3_1Generate001GenerationRequest" }, { "$ref": "#/components/schemas/Veo3_1FastGenerate001GenerationRequest" }, { "$ref": "#/components/schemas/Veo3_1LiteGenerationRequest" }, { "$ref": "#/components/schemas/FluxDevGenerationRequest" }, { "$ref": "#/components/schemas/FluxKontextProGenerationRequest" }, { "$ref": "#/components/schemas/FluxKontextMaxGenerationRequest" }, { "$ref": "#/components/schemas/FluxSchnellGenerationRequest" }, { "$ref": "#/components/schemas/FluxPro2_0GenerationRequest" }, { "$ref": "#/components/schemas/PhoenixV0_9GenerationRequest" }, { "$ref": "#/components/schemas/PhoenixV1_0GenerationRequest" }, { "$ref": "#/components/schemas/KinoXlGenerationRequest" }, { "$ref": "#/components/schemas/AnimeXlGenerationRequest" }, { "$ref": "#/components/schemas/PortraitPerfectGenerationRequest" }, { "$ref": "#/components/schemas/StockPhotographyGenerationRequest" }, { "$ref": "#/components/schemas/IllustrativeAlbedoGenerationRequest" }, { "$ref": "#/components/schemas/ConceptArtGenerationRequest" }, { "$ref": "#/components/schemas/LifelikeVisionGenerationRequest" }, { "$ref": "#/components/schemas/GraphicDesignGenerationRequest" }, { "$ref": "#/components/schemas/LightningXlGenerationRequest" }, { "$ref": "#/components/schemas/IdeogramV3_0GenerationRequest" }, { "$ref": "#/components/schemas/IdeogramV4_0GenerationRequest" }, { "$ref": "#/components/schemas/Ideogram_pImageIdeogramGenerationRequest" }, { "$ref": "#/components/schemas/Ideogram_ideogram4_5GenerationRequest" }, { "$ref": "#/components/schemas/Gemini2_5FlashImageGenerationRequest" }, { "$ref": "#/components/schemas/NanoBanana2GenerationRequest" }, { "$ref": "#/components/schemas/Google_nanoBanana2_1GenerationRequest" }, { "$ref": "#/components/schemas/NanoBanana2LiteGenerationRequest" }, { "$ref": "#/components/schemas/GeminiImage2GenerationRequest" }, { "$ref": "#/components/schemas/Kling2_5GenerationRequest" }, { "$ref": "#/components/schemas/Kling2_6GenerationRequest" }, { "$ref": "#/components/schemas/Kling2_5TurboStandardGenerationRequest" }, { "$ref": "#/components/schemas/LucidOriginGenerationRequest" }, { "$ref": "#/components/schemas/LucidRealismGenerationRequest" }, { "$ref": "#/components/schemas/Ltxv2_3ProGenerationRequest" }, { "$ref": "#/components/schemas/Ltxv2_3FastGenerationRequest" }, { "$ref": "#/components/schemas/HappyHorseGenerationRequest" }, { "$ref": "#/components/schemas/HappyHorse1_1GenerationRequest" }, { "$ref": "#/components/schemas/Hailuo23GenerationRequest" }, { "$ref": "#/components/schemas/Hailuo23FastGenerationRequest" }, { "$ref": "#/components/schemas/Hailuo03GenerationRequest" }, { "$ref": "#/components/schemas/Alibaba_wan3_0GenerationRequest" }, { "$ref": "#/components/schemas/Wan2_7GenerationRequest" }, { "$ref": "#/components/schemas/Bfl_flux3VideoGenerationRequest" }, { "$ref": "#/components/schemas/Bfl_flux3ImageGenerationRequest" }, { "$ref": "#/components/schemas/Wan2_6GenerationRequest" }, { "$ref": "#/components/schemas/Seedance1_0ProGenerationRequest" }, { "$ref": "#/components/schemas/Seedance1_0ProFastGenerationRequest" }, { "$ref": "#/components/schemas/Seedance2_0GenerationRequest" }, { "$ref": "#/components/schemas/Seedance2_0FastGenerationRequest" }, { "$ref": "#/components/schemas/Seedance2_0MiniGenerationRequest" }, { "$ref": "#/components/schemas/Bytedance_seedance2_5GenerationRequest" }, { "$ref": "#/components/schemas/Bytedance_videoUpscalerGenerationRequest" }, { "$ref": "#/components/schemas/GrokImagine1_5GenerationRequest" }, { "$ref": "#/components/schemas/Seedream4_0GenerationRequest" }, { "$ref": "#/components/schemas/Seedream4_5GenerationRequest" }, { "$ref": "#/components/schemas/Seedream5_0ProGenerationRequest" }, { "$ref": "#/components/schemas/Bytedance_seedream5_0FlashGenerationRequest" }, { "$ref": "#/components/schemas/GptImage1_5GenerationRequest" }, { "$ref": "#/components/schemas/GptImage2GenerationRequest" }, { "$ref": "#/components/schemas/Openai_gptImage2_5FlareGenerationRequest" }, { "$ref": "#/components/schemas/Openai_gptImage2_5SunburstGenerationRequest" }, { "$ref": "#/components/schemas/RecraftV4GenerationRequest" }, { "$ref": "#/components/schemas/RecraftV4ProGenerationRequest" }, { "$ref": "#/components/schemas/Krea2TurboGenerationRequest" }, { "$ref": "#/components/schemas/Krea_krea3GenerationRequest" }, { "$ref": "#/components/schemas/Krea_krea2GenerationRequest" }, { "$ref": "#/components/schemas/KlingVideoO1GenerationRequest" }, { "$ref": "#/components/schemas/Kling3_0GenerationRequest" }, { "$ref": "#/components/schemas/Kling3_0TurboGenerationRequest" }, { "$ref": "#/components/schemas/GeminiOmniFlashGenerationRequest" }, { "$ref": "#/components/schemas/Google_geminiOmni1_1FlashPreviewGenerationRequest" }, { "$ref": "#/components/schemas/KlingVideoO3GenerationRequest" }, { "$ref": "#/components/schemas/Kling4_0GenerationRequest" }, { "$ref": "#/components/schemas/AuroraUpscalerCreativeGenerationRequest" }, { "$ref": "#/components/schemas/AuroraUpscalerPreciseGenerationRequest" }, { "$ref": "#/components/schemas/RemoveBgGenerationRequest" }, { "$ref": "#/components/schemas/RodinV2GenerationRequest" }, { "$ref": "#/components/schemas/Meshy_meshy7GenerationRequest" }, { "$ref": "#/components/schemas/MusicV1GenerationRequest" }, { "$ref": "#/components/schemas/SoundEffectsV2GenerationRequest" }, { "$ref": "#/components/schemas/DialogueV3GenerationRequest" }, { "$ref": "#/components/schemas/SeedAudio1_0GenerationRequest" } ] } } }, "description": "Request body for creating a generation", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "generationId": { "nullable": false, "title": "String", "type": "string", "description": "The unique identifier for the generation job." }, "apiCreditCost": { "nullable": true, "title": "Int", "type": "integer", "description": "API Credits Cost for Generation. Available for Production API Users." } } } } }, "description": "Responses for POST /generations" } } } } }, "components": { "schemas": { "Motion2_0GenerationRequest": { "title": "Motion 2.0", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "motion_2.0" ], "description": "Must be `motion_2.0`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ {} ], "oneOf": [ { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 512 ] }, "height": { "enum": [ 768 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 576 ] }, "height": { "enum": [ 720 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 832 ] }, "height": { "enum": [ 480 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 480 ] }, "height": { "enum": [ 832 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1280 ] }, "height": { "enum": [ 720 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 720 ] }, "height": { "enum": [ 1280 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 0 ] }, "height": { "enum": [ 0 ] } } }, { "not": { "anyOf": [ { "required": [ "width" ] }, { "required": [ "height" ] } ] } } ], "required": [ "prompt" ], "properties": { "mode": { "type": "string", "title": "Generation Mode", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Deprecated. Width and height are the canonical inputs for this model. This field is retained for backwards compatibility with mobile clients and Production API consumers that still send `mode`. Validation is silent: omitted is the new norm; explicit values are still consistency-checked against width and height.", "enum": [ "RESOLUTION_480", "RESOLUTION_720" ], "anyOf": [ { "enum": [ "RESOLUTION_480" ] }, { "enum": [ "RESOLUTION_720" ] } ], "default": "RESOLUTION_480", "deprecated": true }, "seed": { "type": "number", "title": "Seed", "description": "The seed value for video generation.", "maximum": 2147483637, "minimum": 0 }, "width": { "allOf": [ { "type": "integer", "title": "Width", "maximum": 9007199254740991, "minimum": 0, "description": "The width of the image to generate in pixels" }, { "enum": [ 512, 576, 832, 480, 1280, 720, 0 ], "type": "integer" } ] }, "height": { "allOf": [ { "type": "integer", "title": "Height", "maximum": 9007199254740991, "minimum": 0, "description": "The height of the image to generate in pixels" }, { "enum": [ 768, 720, 480, 832, 1280, 0 ], "type": "integer" } ] }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "controls": { "type": "array", "items": { "type": "object", "required": [ "akUUID" ], "properties": { "akUUID": { "type": "string", "format": "uuid", "description": "The unique identifier for each motion control item." }, "weight": { "type": "number", "default": 1, "maximum": 2, "minimum": -2, "description": "The weight of the control item (optional)." } } }, "title": "Motion Controls", "maxItems": 1, "description": "An array of Motion Control items (same format, but are defined separately from Motion Elements)." }, "elements": { "type": "array", "items": { "type": "object", "required": [ "akUUID" ], "properties": { "akUUID": { "type": "string", "format": "uuid", "description": "The unique identifier for each motion element or control element." }, "weight": { "type": "number", "default": 1, "maximum": 2, "minimum": -2, "description": "The weight of the element (optional)." } } }, "title": "Motion Elements", "default": [], "description": "An array of Motion Elements (same format, but are defined separately from Motion Control!)" }, "quantity": { "type": "number", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 1 }, "guidances": { "type": "object", "properties": { "start_frame": { "type": "array", "items": { "type": "object", "title": "Start Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "Start Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 } } }, "style_ids": { "type": "array", "items": { "enum": [ "964d8a8f-865b-48c5-b79e-e75ae8727648", "9cdfea2a-b4ab-4e97-a558-ec9fcb78f30a", "12b0d8c9-5cf8-4094-a3e5-6809bc269e21", "c4ac9781-8624-4b7d-bbed-dedaaf7b9da6", "28a53b2e-eb80-41d7-8360-208068fecf49", "d28c8f2b-22bb-4c0c-893d-d3835e28f2f7", "6078b232-d1be-4a01-9c10-95c05132a8e4", "d760b628-4a1d-41cb-bccb-053a13973b94", "c39fe4f8-76d6-4aad-899b-e7ca5a4148f3", "7d36972e-b9d5-46c7-813d-2c9934f9321b", "ff9bfd01-a7ac-4556-889a-25dd5fc0956f", "be32c760-2bb3-49ae-83dc-6f9b2d62a97f", "1d6e92d2-6e83-4ea2-bd4c-34ddfedfa163", "3f705252-1197-4f59-b6ed-21625dce6a65", "64b84d56-8b76-4367-95a6-df345a909af0", "4b60b356-a4ab-4983-9e9a-30e0d5b27bc6", "771bc1bd-0f88-4ff9-af63-f646847ed075", "1974bd47-75bb-499a-9c7a-354913904fcf", "994e33e6-4862-495d-9efb-d9a09ecdd769", "acb9deb3-31e3-495e-ab31-b138fde26bd6", "fa347beb-6d70-482d-94a8-a70736e9e7f1", "746e70e5-ab4d-4f39-9057-75698cb64bc2", "92c2d8d4-9757-4cbf-88f3-d7ea54c425af", "21b0a3e9-304a-4ff2-9603-15ddbc5a6b82", "dcfb60ca-f165-407f-b01c-2b34d22432c2", "913efd9b-1da8-4876-91d3-b6de0aa5582c", "9581d460-7023-4d85-b440-9fea8bbfe194", "9517dd8e-9588-4fe5-aede-6711438dd420", "d26aded5-e191-45d5-9662-db36b7085a76", "2380bd07-caf1-4ae6-a348-3bcf4b12f90a", "6c27f994-2e03-4d07-95b8-4a5db5bd3a27", "1bffb3f3-4110-4185-85f9-f7254ae6f81d", "46af026e-d21a-4cf4-a0c0-b482e6800331", "9243b709-ed08-49d9-9198-440f2127d3b5", "f84bbf31-1d72-415d-ae4c-deb4b18fccba", "d838fb14-9719-44f3-877e-da70d072b79c", "556c1ee5-ec38-42e8-955a-1e82dad0ffa1" ], "type": "string", "format": "uuid" }, "title": "Style IDs for Video Models", "default": [], "description": "An array of zero or more style UUIDs for video models (vibe, lighting, color)." }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" }, "negative_prompt": { "type": "string", "title": "Negative Prompt", "maxLength": 1000, "description": "The negative prompt to use for the generation" }, "frame_interpolation": { "type": "boolean", "title": "Frame Interpolation", "default": true, "description": "Whether the video generation will smoothly blend frames" } }, "description": "Architecture properties of the Motion 2.0 models" } }, "example": { "model": "motion_2.0", "parameters": { "prompt": "your prompt here", "quantity": 1 } } }, "Motion2_0FastGenerationRequest": { "title": "Motion 2.0 Fast", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "motion_2.0-fast" ], "description": "Must be `motion_2.0-fast`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ {} ], "oneOf": [ { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 512 ] }, "height": { "enum": [ 768 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 576 ] }, "height": { "enum": [ 720 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 832 ] }, "height": { "enum": [ 480 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 480 ] }, "height": { "enum": [ 832 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1280 ] }, "height": { "enum": [ 720 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 720 ] }, "height": { "enum": [ 1280 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 0 ] }, "height": { "enum": [ 0 ] } } }, { "not": { "anyOf": [ { "required": [ "width" ] }, { "required": [ "height" ] } ] } } ], "required": [ "prompt" ], "properties": { "mode": { "type": "string", "title": "Generation Mode", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Deprecated. Width and height are the canonical inputs for this model. This field is retained for backwards compatibility with mobile clients and Production API consumers that still send `mode`. Validation is silent: omitted is the new norm; explicit values are still consistency-checked against width and height.", "enum": [ "RESOLUTION_480", "RESOLUTION_720" ], "anyOf": [ { "enum": [ "RESOLUTION_480" ] }, { "enum": [ "RESOLUTION_720" ] } ], "default": "RESOLUTION_480", "deprecated": true }, "seed": { "type": "number", "title": "Seed", "description": "The seed value for video generation.", "maximum": 4294967295, "minimum": 0 }, "width": { "allOf": [ { "type": "integer", "title": "Width", "maximum": 9007199254740991, "minimum": 0, "description": "The width of the image to generate in pixels" }, { "enum": [ 512, 576, 832, 480, 1280, 720, 0 ], "type": "integer" } ] }, "height": { "allOf": [ { "type": "integer", "title": "Height", "maximum": 9007199254740991, "minimum": 0, "description": "The height of the image to generate in pixels" }, { "enum": [ 768, 720, 480, 832, 1280, 0 ], "type": "integer" } ] }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "controls": { "type": "array", "items": { "type": "object", "required": [ "akUUID" ], "properties": { "akUUID": { "type": "string", "format": "uuid", "description": "The unique identifier for each motion control item." }, "weight": { "type": "number", "default": 1, "maximum": 2, "minimum": -2, "description": "The weight of the control item (optional)." } } }, "title": "Motion Controls", "maxItems": 1, "description": "An array of Motion Control items (same format, but are defined separately from Motion Elements)." }, "elements": { "type": "array", "items": { "type": "object", "required": [ "akUUID" ], "properties": { "akUUID": { "type": "string", "format": "uuid", "description": "The unique identifier for each motion element or control element." }, "weight": { "type": "number", "default": 1, "maximum": 2, "minimum": -2, "description": "The weight of the element (optional)." } } }, "title": "Motion Elements", "default": [], "description": "An array of Motion Elements (same format, but are defined separately from Motion Control!)" }, "quantity": { "type": "number", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 1 }, "guidances": { "type": "object", "properties": { "start_frame": { "type": "array", "items": { "type": "object", "title": "Start Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "Start Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 } } }, "style_ids": { "type": "array", "items": { "enum": [ "964d8a8f-865b-48c5-b79e-e75ae8727648", "9cdfea2a-b4ab-4e97-a558-ec9fcb78f30a", "12b0d8c9-5cf8-4094-a3e5-6809bc269e21", "c4ac9781-8624-4b7d-bbed-dedaaf7b9da6", "28a53b2e-eb80-41d7-8360-208068fecf49", "d28c8f2b-22bb-4c0c-893d-d3835e28f2f7", "6078b232-d1be-4a01-9c10-95c05132a8e4", "d760b628-4a1d-41cb-bccb-053a13973b94", "c39fe4f8-76d6-4aad-899b-e7ca5a4148f3", "7d36972e-b9d5-46c7-813d-2c9934f9321b", "ff9bfd01-a7ac-4556-889a-25dd5fc0956f", "be32c760-2bb3-49ae-83dc-6f9b2d62a97f", "1d6e92d2-6e83-4ea2-bd4c-34ddfedfa163", "3f705252-1197-4f59-b6ed-21625dce6a65", "64b84d56-8b76-4367-95a6-df345a909af0", "4b60b356-a4ab-4983-9e9a-30e0d5b27bc6", "771bc1bd-0f88-4ff9-af63-f646847ed075", "1974bd47-75bb-499a-9c7a-354913904fcf", "994e33e6-4862-495d-9efb-d9a09ecdd769", "acb9deb3-31e3-495e-ab31-b138fde26bd6", "fa347beb-6d70-482d-94a8-a70736e9e7f1", "746e70e5-ab4d-4f39-9057-75698cb64bc2", "92c2d8d4-9757-4cbf-88f3-d7ea54c425af", "21b0a3e9-304a-4ff2-9603-15ddbc5a6b82", "dcfb60ca-f165-407f-b01c-2b34d22432c2", "913efd9b-1da8-4876-91d3-b6de0aa5582c", "9581d460-7023-4d85-b440-9fea8bbfe194", "9517dd8e-9588-4fe5-aede-6711438dd420", "d26aded5-e191-45d5-9662-db36b7085a76", "2380bd07-caf1-4ae6-a348-3bcf4b12f90a", "6c27f994-2e03-4d07-95b8-4a5db5bd3a27", "1bffb3f3-4110-4185-85f9-f7254ae6f81d", "46af026e-d21a-4cf4-a0c0-b482e6800331", "9243b709-ed08-49d9-9198-440f2127d3b5", "f84bbf31-1d72-415d-ae4c-deb4b18fccba", "d838fb14-9719-44f3-877e-da70d072b79c", "556c1ee5-ec38-42e8-955a-1e82dad0ffa1" ], "type": "string", "format": "uuid" }, "title": "Style IDs for Video Models", "default": [], "description": "An array of zero or more style UUIDs for video models (vibe, lighting, color)." }, "start_frame": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Video start frame", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "The start frame init_image to start a generation with", "deprecated": true }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" }, "negative_prompt": { "type": "string", "title": "Negative Prompt", "maxLength": 1000, "description": "The negative prompt to use for the generation" }, "frame_interpolation": { "type": "boolean", "title": "Frame Interpolation", "default": true, "description": "Whether the video generation will smoothly blend frames" } }, "description": "Architecture properties of the Motion 2.0 Fast model" } }, "example": { "model": "motion_2.0-fast", "parameters": { "prompt": "your prompt here", "quantity": 1 } } }, "Veo3_1Generate001GenerationRequest": { "title": "Veo 3.1", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "veo-3.1-generate-001" ], "description": "Must be `veo-3.1-generate-001`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ { "not": { "anyOf": [ { "allOf": [ { "required": [ "start_frame" ] }, { "required": [ "guidances" ], "properties": { "guidances": { "type": "object", "required": [ "start_frame" ], "properties": { "start_frame": { "type": "array", "minItems": 1 } } } } } ] }, { "allOf": [ { "required": [ "end_frame" ] }, { "required": [ "guidances" ], "properties": { "guidances": { "type": "object", "required": [ "end_frame" ], "properties": { "end_frame": { "type": "array", "minItems": 1 } } } } } ] } ] } }, { "anyOf": [ { "type": "object", "properties": { "width": { "enum": [ 1280 ] }, "height": { "enum": [ 720 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 720 ] }, "height": { "enum": [ 1280 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1920 ] }, "height": { "enum": [ 1080 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1080 ] }, "height": { "enum": [ 1920 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 3840 ] }, "height": { "enum": [ 2160 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 2160 ] }, "height": { "enum": [ 3840 ] } } } ] } ], "required": [ "prompt", "quantity" ], "properties": { "mode": { "type": "string", "title": "Quality", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Deprecated. Width and height are the canonical inputs for this model. This field is retained for backwards compatibility with mobile clients and Production API consumers that still send `mode`. Validation is silent: omitted is the new norm; explicit values are still consistency-checked against width and height.", "enum": [ "RESOLUTION_720", "RESOLUTION_1080", "RESOLUTION_2160" ], "anyOf": [ { "enum": [ "RESOLUTION_720" ] }, { "enum": [ "RESOLUTION_1080" ] }, { "enum": [ "RESOLUTION_2160" ] } ], "default": "RESOLUTION_720", "deprecated": true }, "seed": { "type": "number", "title": "Seed", "description": "The seed value for generation", "maximum": 4294967295, "minimum": 0 }, "audio": { "type": "boolean", "title": "Audio", "default": true, "description": "Whether the video generation will include audio.", "deprecated": true }, "width": { "enum": [ 720, 1080, 1280, 1920, 2160, 3840 ], "type": "integer", "default": 1280 }, "height": { "enum": [ 720, 1080, 1280, 1920, 2160, 3840 ], "type": "integer", "default": 720 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "duration": { "type": "integer", "title": "Duration", "description": "Duration of the video in seconds", "enum": [ 4, 6, 8 ], "default": 8 }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 1 }, "end_frame": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Video end frame", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "The end frame image to end a generation with", "deprecated": true }, "guidances": { "type": "object", "properties": { "end_frame": { "type": "array", "items": { "type": "object", "title": "End Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "End Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 }, "start_frame": { "type": "array", "items": { "type": "object", "title": "Start Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "Start Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 }, "image_reference": { "type": "array", "items": { "properties": { "image": { "properties": { "contentType": { "enum": [ "image/jpeg", "image/png" ] } } } } }, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 3 } }, "additionalProperties": false }, "start_frame": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Video start frame", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "The start frame init_image to start a generation with", "deprecated": true }, "negative_prompt": { "type": "string", "title": "Negative Prompt", "maxLength": 1000, "description": "The negative prompt to use for the generation" }, "motion_has_audio": { "type": "boolean", "title": "Audio", "default": true, "description": "Whether the video generation will include audio.", "anyOf": [ { "enum": [ true ] }, { "enum": [ false ] } ] } } } }, "example": { "model": "veo-3.1-generate-001", "parameters": { "width": 1280, "height": 720, "prompt": "your prompt here", "duration": 8, "quantity": 1, "motion_has_audio": true } } }, "Veo3_1FastGenerate001GenerationRequest": { "title": "Veo 3.1 Fast", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "veo-3.1-fast-generate-001" ], "description": "Must be `veo-3.1-fast-generate-001`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ { "not": { "anyOf": [ { "allOf": [ { "required": [ "start_frame" ] }, { "required": [ "guidances" ], "properties": { "guidances": { "type": "object", "required": [ "start_frame" ], "properties": { "start_frame": { "type": "array", "minItems": 1 } } } } } ] }, { "allOf": [ { "required": [ "end_frame" ] }, { "required": [ "guidances" ], "properties": { "guidances": { "type": "object", "required": [ "end_frame" ], "properties": { "end_frame": { "type": "array", "minItems": 1 } } } } } ] } ] } }, { "anyOf": [ { "type": "object", "properties": { "width": { "enum": [ 1280 ] }, "height": { "enum": [ 720 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 720 ] }, "height": { "enum": [ 1280 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1920 ] }, "height": { "enum": [ 1080 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1080 ] }, "height": { "enum": [ 1920 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 3840 ] }, "height": { "enum": [ 2160 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 2160 ] }, "height": { "enum": [ 3840 ] } } } ] } ], "required": [ "prompt", "quantity" ], "properties": { "mode": { "type": "string", "title": "Quality", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Deprecated. Width and height are the canonical inputs for this model. This field is retained for backwards compatibility with mobile clients and Production API consumers that still send `mode`. Validation is silent: omitted is the new norm; explicit values are still consistency-checked against width and height.", "enum": [ "RESOLUTION_720", "RESOLUTION_1080", "RESOLUTION_2160" ], "anyOf": [ { "enum": [ "RESOLUTION_720" ] }, { "enum": [ "RESOLUTION_1080" ] }, { "enum": [ "RESOLUTION_2160" ] } ], "default": "RESOLUTION_720", "deprecated": true }, "seed": { "type": "number", "title": "Seed", "description": "The seed value for generation", "maximum": 4294967295, "minimum": 0 }, "audio": { "type": "boolean", "title": "Audio", "default": true, "description": "Whether the video generation will include audio.", "deprecated": true }, "width": { "enum": [ 720, 1080, 1280, 1920, 2160, 3840 ], "type": "integer", "default": 1280 }, "height": { "enum": [ 720, 1080, 1280, 1920, 2160, 3840 ], "type": "integer", "default": 720 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "duration": { "type": "integer", "title": "Duration", "description": "Duration of the video in seconds", "enum": [ 4, 6, 8 ], "default": 8 }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 1 }, "end_frame": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Video end frame", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "The end frame image to end a generation with", "deprecated": true }, "guidances": { "type": "object", "properties": { "end_frame": { "type": "array", "items": { "type": "object", "title": "End Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "End Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 }, "start_frame": { "type": "array", "items": { "type": "object", "title": "Start Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "Start Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 } }, "additionalProperties": false }, "start_frame": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Video start frame", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "The start frame init_image to start a generation with", "deprecated": true }, "negative_prompt": { "type": "string", "title": "Negative Prompt", "maxLength": 1000, "description": "The negative prompt to use for the generation" }, "motion_has_audio": { "type": "boolean", "title": "Audio", "default": true, "description": "Whether the video generation will include audio.", "anyOf": [ { "enum": [ true ] }, { "enum": [ false ] } ] } } } }, "example": { "model": "veo-3.1-fast-generate-001", "parameters": { "width": 1280, "height": 720, "prompt": "your prompt here", "duration": 8, "quantity": 1, "motion_has_audio": true } } }, "Veo3_1LiteGenerationRequest": { "title": "Veo 3.1 Lite", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "veo-3.1-lite" ], "description": "Must be `veo-3.1-lite`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ { "not": { "anyOf": [ { "allOf": [ { "required": [ "start_frame" ] }, { "required": [ "guidances" ], "properties": { "guidances": { "type": "object", "required": [ "start_frame" ], "properties": { "start_frame": { "type": "array", "minItems": 1 } } } } } ] }, { "allOf": [ { "required": [ "end_frame" ] }, { "required": [ "guidances" ], "properties": { "guidances": { "type": "object", "required": [ "end_frame" ], "properties": { "end_frame": { "type": "array", "minItems": 1 } } } } } ] } ] } }, { "anyOf": [ { "type": "object", "properties": { "width": { "enum": [ 1280 ] }, "height": { "enum": [ 720 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 720 ] }, "height": { "enum": [ 1280 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1920 ] }, "height": { "enum": [ 1080 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1080 ] }, "height": { "enum": [ 1920 ] } } } ] }, {}, {}, {} ], "required": [ "prompt", "quantity" ], "properties": { "mode": { "type": "string", "title": "Quality", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Deprecated. Width and height are the canonical inputs for this model. This field is retained for backwards compatibility with mobile clients and Production API consumers that still send `mode`. Validation is silent: omitted is the new norm; explicit values are still consistency-checked against width and height.", "enum": [ "RESOLUTION_720", "RESOLUTION_1080" ], "anyOf": [ { "enum": [ "RESOLUTION_720" ] }, { "enum": [ "RESOLUTION_1080" ] } ], "default": "RESOLUTION_720", "deprecated": true }, "seed": { "type": "number", "title": "Seed", "description": "The seed value for generation", "maximum": 4294967295, "minimum": 0 }, "audio": { "type": "boolean", "title": "Audio", "default": true, "description": "Whether the video generation will include audio.", "deprecated": true }, "width": { "enum": [ 720, 1080, 1280, 1920 ], "type": "integer", "default": 1280 }, "height": { "enum": [ 720, 1080, 1280, 1920 ], "type": "integer", "default": 720 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "duration": { "type": "integer", "title": "Duration", "description": "Duration of the video in seconds", "enum": [ 4, 6, 8 ], "default": 8 }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 1 }, "end_frame": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Video end frame", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "The end frame image to end a generation with", "deprecated": true }, "guidances": { "type": "object", "properties": { "end_frame": { "type": "array", "items": { "type": "object", "title": "End Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "End Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 }, "start_frame": { "type": "array", "items": { "type": "object", "title": "Start Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "Start Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 } }, "additionalProperties": false }, "start_frame": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Video start frame", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "The start frame init_image to start a generation with", "deprecated": true }, "negative_prompt": { "type": "string", "title": "Negative Prompt", "maxLength": 1000, "description": "The negative prompt to use for the generation" }, "motion_has_audio": { "type": "boolean", "title": "Audio", "default": true, "description": "Whether the video generation will include audio." } } } }, "example": { "model": "veo-3.1-lite", "parameters": { "width": 1280, "height": 720, "prompt": "your prompt here", "duration": 8, "quantity": 1, "motion_has_audio": true } } }, "FluxDevGenerationRequest": { "title": "FLUX Dev", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "flux-dev" ], "description": "Must be `flux-dev`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt" ], "properties": { "seed": { "type": "integer", "title": "Seed", "description": "The seed value for generation", "maximum": 2147483637, "minimum": 0 }, "width": { "type": "integer", "title": "Width", "maximum": 2048, "minimum": 480, "description": "The width of the image to generate in pixels", "default": 1024, "multipleOf": 8 }, "height": { "type": "integer", "title": "Height", "maximum": 2048, "minimum": 480, "description": "The height of the image to generate in pixels", "default": 1024, "multipleOf": 8 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 2000, "minLength": 1, "description": "The prompt to use for the generation" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 4, "maximum": 8 }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "properties": { "style": { "type": "array", "items": { "type": "object", "title": "Style reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH", "ULTRA", "MAX" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Style transfer guidance object, containing parameters available for style transfer image guidance" }, "title": "Style Reference", "description": "References the style from the input image to guide your image generation.", "maxItems": 1 }, "content": { "type": "array", "items": { "type": "object", "title": "Content reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH", "ULTRA" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Content transfer guidance object, containing parameters available for content transfer image guidance" }, "title": "Content Reference", "description": "References the form and content from the input image to guide your image generation.", "maxItems": 1 } } }, "style_ids": { "type": "array", "items": { "enum": [ "debdf72a-91a4-467b-bf61-cc02bdeb69c6", "3cbb655a-7ca4-463f-b697-8a03ad67327c", "b2a54a51-230b-4d4f-ad4e-8409bf58645f", "6fedbf1f-4a17-45ec-84fb-92fe524a29ef", "111dc692-d470-4eec-b791-3475abac4c46", "594c4a08-a522-4e0e-b7ff-e4dac4b6b622", "09d2b5b5-d7c5-4c02-905d-9f84051640f4", "7d7c2bc5-4b12-4ac3-81a9-630057e9e89f", "645e4195-f63d-4715-a3f2-3fb1e6eb8c70", "ab5a4220-7c42-41e5-a578-eddb9fed3d75", "4edb03c9-8a26-4041-9d01-f85b5d4abd71", "0d34f8e1-46d4-428f-8ddd-4b11811fa7c9", "b504f83c-3326-4947-82e1-7fe9e839ec0f", "5bdc3f2a-1be6-4d1c-8e77-992a30824a2c", "1db308ce-c7ad-4d10-96fd-592fa6b75cc4", "556c1ee5-ec38-42e8-955a-1e82dad0ffa1" ], "type": "string", "format": "uuid" }, "title": "Style IDs for Image Models", "default": [ "111dc692-d470-4eec-b791-3475abac4c46" ], "description": "An array of style UUIDs for image models (limited to 1 style)." }, "user_elements": { "type": "array", "items": { "type": "object", "required": [ "userLoraId" ], "properties": { "weight": { "type": "number", "default": 1, "maximum": 2, "minimum": -2, "description": "The weight of the element (optional)." }, "userLoraId": { "type": "integer", "description": "The unique identifier for each user-trained element." } } }, "title": "Your Elements", "default": [], "description": "An array of User Elements for image generation.", "maxItems": 4 }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" }, "platform_elements": { "type": "array", "items": { "type": "object", "required": [ "akUUID" ], "properties": { "akUUID": { "type": "string", "format": "uuid", "description": "The unique identifier for each platform element." }, "weight": { "type": "number", "default": 1, "maximum": 2, "minimum": -2, "description": "The weight of the element (optional)." } } }, "title": "Platform Elements", "default": [], "description": "An array of Platform Elements for image generation.", "maxItems": 4 } }, "description": "Flux Model Parameters" } }, "example": { "model": "flux-dev", "parameters": { "width": 1024, "height": 1024, "prompt": "your prompt here", "quantity": 4, "style_ids": [ "111dc692-d470-4eec-b791-3475abac4c46" ] } } }, "FluxKontextProGenerationRequest": { "title": "FLUX.1 Kontext", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "flux-kontext-pro" ], "description": "Must be `flux-kontext-pro`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt" ], "properties": { "seed": { "type": "integer", "title": "Seed", "description": "The seed value for generation", "maximum": 2147483637, "minimum": 0 }, "width": { "type": "integer", "title": "Width", "maximum": 2048, "minimum": 32, "description": "The width of the image to generate in pixels", "default": 1024 }, "height": { "type": "integer", "title": "Height", "maximum": 2048, "minimum": 32, "description": "The height of the image to generate in pixels", "default": 1024 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 4, "maximum": 8 }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "properties": { "image_reference": { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" } }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 4 } } }, "style_ids": { "type": "array", "items": { "enum": [ "debdf72a-91a4-467b-bf61-cc02bdeb69c6", "3cbb655a-7ca4-463f-b697-8a03ad67327c", "6fedbf1f-4a17-45ec-84fb-92fe524a29ef", "111dc692-d470-4eec-b791-3475abac4c46", "594c4a08-a522-4e0e-b7ff-e4dac4b6b622", "09d2b5b5-d7c5-4c02-905d-9f84051640f4", "703d6fe5-7f1c-4a9e-8da0-5331f214d5cf", "7d7c2bc5-4b12-4ac3-81a9-630057e9e89f", "645e4195-f63d-4715-a3f2-3fb1e6eb8c70", "ab5a4220-7c42-41e5-a578-eddb9fed3d75", "4edb03c9-8a26-4041-9d01-f85b5d4abd71", "0d34f8e1-46d4-428f-8ddd-4b11811fa7c9", "22a9a7d2-2166-4d86-80ff-22e2643adbcf", "7c3f932b-a572-47cb-9b9b-f20211e63b5b", "581ba6d6-5aac-4492-bebe-54c424a0d46e", "b504f83c-3326-4947-82e1-7fe9e839ec0f", "5bdc3f2a-1be6-4d1c-8e77-992a30824a2c", "1db308ce-c7ad-4d10-96fd-592fa6b75cc4", "556c1ee5-ec38-42e8-955a-1e82dad0ffa1" ], "type": "string", "format": "uuid" }, "title": "Style IDs for Image Models", "default": [ "111dc692-d470-4eec-b791-3475abac4c46" ], "description": "An array of style UUIDs for image models (limited to 1 style)." }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" } } } }, "example": { "model": "flux-kontext-pro", "parameters": { "width": 1024, "height": 1024, "prompt": "your prompt here", "quantity": 4, "style_ids": [ "111dc692-d470-4eec-b791-3475abac4c46" ] } } }, "FluxKontextMaxGenerationRequest": { "title": "FLUX.1 Kontext Max", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "flux-kontext-max" ], "description": "Must be `flux-kontext-max`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt" ], "properties": { "seed": { "type": "integer", "title": "Seed", "description": "The seed value for generation", "maximum": 4294967295, "minimum": 0 }, "width": { "type": "integer", "title": "Width", "maximum": 2048, "minimum": 32, "description": "The width of the image to generate in pixels", "default": 1024 }, "height": { "type": "integer", "title": "Height", "maximum": 2048, "minimum": 32, "description": "The height of the image to generate in pixels", "default": 1024 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 4, "maximum": 8 }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "properties": { "image_reference": { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" } }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 4 } } }, "style_ids": { "type": "array", "items": { "enum": [ "debdf72a-91a4-467b-bf61-cc02bdeb69c6", "3cbb655a-7ca4-463f-b697-8a03ad67327c", "6fedbf1f-4a17-45ec-84fb-92fe524a29ef", "111dc692-d470-4eec-b791-3475abac4c46", "594c4a08-a522-4e0e-b7ff-e4dac4b6b622", "09d2b5b5-d7c5-4c02-905d-9f84051640f4", "703d6fe5-7f1c-4a9e-8da0-5331f214d5cf", "7d7c2bc5-4b12-4ac3-81a9-630057e9e89f", "645e4195-f63d-4715-a3f2-3fb1e6eb8c70", "ab5a4220-7c42-41e5-a578-eddb9fed3d75", "4edb03c9-8a26-4041-9d01-f85b5d4abd71", "0d34f8e1-46d4-428f-8ddd-4b11811fa7c9", "22a9a7d2-2166-4d86-80ff-22e2643adbcf", "7c3f932b-a572-47cb-9b9b-f20211e63b5b", "581ba6d6-5aac-4492-bebe-54c424a0d46e", "b504f83c-3326-4947-82e1-7fe9e839ec0f", "5bdc3f2a-1be6-4d1c-8e77-992a30824a2c", "1db308ce-c7ad-4d10-96fd-592fa6b75cc4", "556c1ee5-ec38-42e8-955a-1e82dad0ffa1" ], "type": "string", "format": "uuid" }, "title": "Style IDs for Image Models", "default": [ "111dc692-d470-4eec-b791-3475abac4c46" ], "description": "An array of style UUIDs for image models (limited to 1 style)." }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" } } } }, "example": { "model": "flux-kontext-max", "parameters": { "width": 1024, "height": 1024, "prompt": "your prompt here", "quantity": 4, "style_ids": [ "111dc692-d470-4eec-b791-3475abac4c46" ] } } }, "FluxSchnellGenerationRequest": { "title": "FLUX Schnell", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "flux-schnell" ], "description": "Must be `flux-schnell`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt" ], "properties": { "seed": { "type": "integer", "title": "Seed", "description": "The seed value for generation", "maximum": 2147483637, "minimum": 0 }, "width": { "type": "integer", "title": "Width", "maximum": 2048, "minimum": 32, "description": "The width of the image to generate in pixels", "default": 1024, "multipleOf": 8 }, "height": { "type": "integer", "title": "Height", "maximum": 2048, "minimum": 32, "description": "The height of the image to generate in pixels", "default": 1024, "multipleOf": 8 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 2000, "minLength": 1, "description": "The prompt to use for the generation" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 4, "maximum": 8 }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "properties": { "style": { "type": "array", "items": { "type": "object", "title": "Style reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH", "ULTRA", "MAX" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Style transfer guidance object, containing parameters available for style transfer image guidance" }, "title": "Style Reference", "description": "References the style from the input image to guide your image generation.", "maxItems": 1 }, "content": { "type": "array", "items": { "type": "object", "title": "Content reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH", "ULTRA" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Content transfer guidance object, containing parameters available for content transfer image guidance" }, "title": "Content Reference", "description": "References the form and content from the input image to guide your image generation.", "maxItems": 1 } } }, "style_ids": { "type": "array", "items": { "enum": [ "debdf72a-91a4-467b-bf61-cc02bdeb69c6", "3cbb655a-7ca4-463f-b697-8a03ad67327c", "b2a54a51-230b-4d4f-ad4e-8409bf58645f", "6fedbf1f-4a17-45ec-84fb-92fe524a29ef", "111dc692-d470-4eec-b791-3475abac4c46", "594c4a08-a522-4e0e-b7ff-e4dac4b6b622", "09d2b5b5-d7c5-4c02-905d-9f84051640f4", "7d7c2bc5-4b12-4ac3-81a9-630057e9e89f", "645e4195-f63d-4715-a3f2-3fb1e6eb8c70", "ab5a4220-7c42-41e5-a578-eddb9fed3d75", "4edb03c9-8a26-4041-9d01-f85b5d4abd71", "0d34f8e1-46d4-428f-8ddd-4b11811fa7c9", "b504f83c-3326-4947-82e1-7fe9e839ec0f", "5bdc3f2a-1be6-4d1c-8e77-992a30824a2c", "1db308ce-c7ad-4d10-96fd-592fa6b75cc4", "556c1ee5-ec38-42e8-955a-1e82dad0ffa1" ], "type": "string", "format": "uuid" }, "title": "Style IDs for Image Models", "default": [ "111dc692-d470-4eec-b791-3475abac4c46" ], "description": "An array of style UUIDs for image models (limited to 1 style)." }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" } }, "description": "Flux Model Parameters" } }, "example": { "model": "flux-schnell", "parameters": { "width": 1024, "height": 1024, "prompt": "your prompt here", "quantity": 4, "style_ids": [ "111dc692-d470-4eec-b791-3475abac4c46" ] } } }, "FluxPro2_0GenerationRequest": { "title": "FLUX.2 Pro", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "flux-pro-2.0" ], "description": "Must be `flux-pro-2.0`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt" ], "properties": { "seed": { "type": "integer", "title": "Seed", "description": "The seed value for generation", "maximum": 4294967295, "minimum": 0 }, "width": { "type": "integer", "title": "Width", "maximum": 14142, "minimum": 64, "description": "The width of the image to generate in pixels", "default": 1440 }, "height": { "type": "integer", "title": "Height", "maximum": 14142, "minimum": 64, "description": "The height of the image to generate in pixels", "default": 1440 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 4, "maximum": 8 }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "properties": { "image_reference": { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" } }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 4 } } }, "style_ids": { "type": "array", "items": { "enum": [ "debdf72a-91a4-467b-bf61-cc02bdeb69c6", "3cbb655a-7ca4-463f-b697-8a03ad67327c", "6fedbf1f-4a17-45ec-84fb-92fe524a29ef", "111dc692-d470-4eec-b791-3475abac4c46", "594c4a08-a522-4e0e-b7ff-e4dac4b6b622", "09d2b5b5-d7c5-4c02-905d-9f84051640f4", "703d6fe5-7f1c-4a9e-8da0-5331f214d5cf", "7d7c2bc5-4b12-4ac3-81a9-630057e9e89f", "645e4195-f63d-4715-a3f2-3fb1e6eb8c70", "ab5a4220-7c42-41e5-a578-eddb9fed3d75", "4edb03c9-8a26-4041-9d01-f85b5d4abd71", "0d34f8e1-46d4-428f-8ddd-4b11811fa7c9", "22a9a7d2-2166-4d86-80ff-22e2643adbcf", "7c3f932b-a572-47cb-9b9b-f20211e63b5b", "581ba6d6-5aac-4492-bebe-54c424a0d46e", "b504f83c-3326-4947-82e1-7fe9e839ec0f", "5bdc3f2a-1be6-4d1c-8e77-992a30824a2c", "1db308ce-c7ad-4d10-96fd-592fa6b75cc4", "556c1ee5-ec38-42e8-955a-1e82dad0ffa1" ], "type": "string", "format": "uuid" }, "title": "Style IDs for Image Models", "default": [ "111dc692-d470-4eec-b791-3475abac4c46" ], "description": "An array of style UUIDs for image models (limited to 1 style)." }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" } } } }, "example": { "model": "flux-pro-2.0", "parameters": { "width": 1440, "height": 1440, "prompt": "your prompt here", "quantity": 4, "style_ids": [ "111dc692-d470-4eec-b791-3475abac4c46" ] } } }, "PhoenixV0_9GenerationRequest": { "title": "Phoenix 0.9", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "phoenix-v0.9" ], "description": "Must be `phoenix-v0.9`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt" ], "properties": { "mode": { "type": "string", "title": "Generation Mode", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Use this instead of `quality` for all proprietary models!", "enum": [ "FAST", "QUALITY", "ULTRA" ], "anyOf": [ { "enum": [ "FAST" ] }, { "enum": [ "QUALITY" ] }, { "enum": [ "ULTRA" ] } ], "default": "FAST" }, "seed": { "type": "integer", "title": "Seed", "description": "The seed value for generation", "minimum": 0 }, "width": { "type": "integer", "title": "Width", "maximum": 2048, "minimum": 32, "description": "The width of the image to generate in pixels", "default": 1024, "multipleOf": 8 }, "height": { "type": "integer", "title": "Height", "maximum": 2048, "minimum": 32, "description": "The height of the image to generate in pixels", "default": 1024, "multipleOf": 8 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 2000, "minLength": 1, "description": "The prompt to use for the generation" }, "tiling": { "type": "boolean", "title": "Tiling" }, "contrast": { "enum": [ "LOW", "MEDIUM", "HIGH" ], "type": "string", "title": "Contrast", "default": "MEDIUM", "description": "The contrast the image should have" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 4, "maximum": 8 }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "properties": { "style": { "type": "array", "items": { "type": "object", "title": "Style reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH", "ULTRA", "MAX" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Style transfer guidance object, containing parameters available for style transfer image guidance" }, "title": "Style Reference", "description": "References the style from the input image to guide your image generation.", "maxItems": 4 }, "content": { "type": "array", "items": { "type": "object", "title": "Content reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH", "ULTRA" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Content transfer guidance object, containing parameters available for content transfer image guidance" }, "title": "Content Reference", "description": "References the form and content from the input image to guide your image generation.", "maxItems": 1 }, "character": { "type": "array", "items": { "type": "object", "title": "Character reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Character transfer guidance object, containing parameters available for character transfer image guidance" }, "title": "Content Reference", "description": "Generates an image in the likeness of the provided character reference image (works best with close up face portraits).", "maxItems": 1 }, "image_to_image": { "type": "array", "items": { "type": "object", "title": "Image to image", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the image to image guidance" } }, "description": "Image to image guidance object, containing parameters available for image to image guidance" }, "title": "Image to Image", "description": "Creative reinterpretation of vibe or structure from a reference image.", "maxItems": 1 } } }, "style_ids": { "type": "array", "items": { "enum": [ "debdf72a-91a4-467b-bf61-cc02bdeb69c6", "9fdc5e8c-4d13-49b4-9ce6-5a74cbb19177", "a5632c7c-ddbb-4e2f-ba34-8456ab3ac436", "33abbb99-03b9-4dd7-9761-ee98650b2c88", "6fedbf1f-4a17-45ec-84fb-92fe524a29ef", "111dc692-d470-4eec-b791-3475abac4c46", "594c4a08-a522-4e0e-b7ff-e4dac4b6b622", "2e74ec31-f3a4-4825-b08b-2894f6d13941", "1fbb6a68-9319-44d2-8d56-2957ca0ece6a", "645e4195-f63d-4715-a3f2-3fb1e6eb8c70", "30c1d34f-e3a9-479a-b56f-c018bbc9c02a", "cadc8cd6-7838-4c99-b645-df76be8ba8d8", "621e1c9a-6319-4bee-a12d-ae40659162fa", "ab5a4220-7c42-41e5-a578-eddb9fed3d75", "22a9a7d2-2166-4d86-80ff-22e2643adbcf", "7c3f932b-a572-47cb-9b9b-f20211e63b5b", "581ba6d6-5aac-4492-bebe-54c424a0d46e", "b504f83c-3326-4947-82e1-7fe9e839ec0f", "be8c6b58-739c-4d44-b9c1-b032ed308b61", "093accc3-7633-4ffd-82da-d34000dfc0d6", "5bdc3f2a-1be6-4d1c-8e77-992a30824a2c", "dee282d3-891f-4f73-ba02-7f8131e5541b", "556c1ee5-ec38-42e8-955a-1e82dad0ffa1" ], "type": "string", "format": "uuid" }, "title": "Style IDs for Image Models", "default": [ "111dc692-d470-4eec-b791-3475abac4c46" ], "description": "An array of style UUIDs for image models (limited to 1 style)." }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" }, "negative_prompt": { "type": "string", "title": "Negative Prompt", "maxLength": 1000, "description": "The negative prompt to use for the generation" } }, "description": "Phoenix 0.9 Model Parameters" } }, "example": { "model": "phoenix-v0.9", "parameters": { "mode": "FAST", "width": 1024, "height": 1024, "prompt": "your prompt here", "quantity": 4, "style_ids": [ "111dc692-d470-4eec-b791-3475abac4c46" ] } } }, "PhoenixV1_0GenerationRequest": { "title": "Phoenix 1.0", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "phoenix-v1.0" ], "description": "Must be `phoenix-v1.0`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt" ], "properties": { "mode": { "type": "string", "title": "Generation Mode", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Use this instead of `quality` for all proprietary models!", "enum": [ "FAST", "QUALITY", "ULTRA" ], "anyOf": [ { "enum": [ "FAST" ] }, { "enum": [ "QUALITY" ] }, { "enum": [ "ULTRA" ] } ], "default": "FAST" }, "seed": { "type": "integer", "title": "Seed", "description": "The seed value for generation", "minimum": 0 }, "width": { "type": "integer", "title": "Width", "maximum": 2048, "minimum": 32, "description": "The width of the image to generate in pixels", "default": 1024, "multipleOf": 8 }, "height": { "type": "integer", "title": "Height", "maximum": 2048, "minimum": 32, "description": "The height of the image to generate in pixels", "default": 1024, "multipleOf": 8 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 2000, "minLength": 1, "description": "The prompt to use for the generation" }, "tiling": { "type": "boolean", "title": "Tiling" }, "contrast": { "enum": [ "LOW", "MEDIUM", "HIGH" ], "type": "string", "title": "Contrast", "default": "MEDIUM", "description": "The contrast the image should have" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 4, "maximum": 8 }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "properties": { "style": { "type": "array", "items": { "type": "object", "title": "Style reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH", "ULTRA", "MAX" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Style transfer guidance object, containing parameters available for style transfer image guidance" }, "title": "Style Reference", "description": "References the style from the input image to guide your image generation.", "maxItems": 4 }, "content": { "type": "array", "items": { "type": "object", "title": "Content reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH", "ULTRA" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Content transfer guidance object, containing parameters available for content transfer image guidance" }, "title": "Content Reference", "description": "References the form and content from the input image to guide your image generation.", "maxItems": 1 }, "character": { "type": "array", "items": { "type": "object", "title": "Character reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Character transfer guidance object, containing parameters available for character transfer image guidance" }, "title": "Content Reference", "description": "Generates an image in the likeness of the provided character reference image (works best with close up face portraits).", "maxItems": 1 }, "image_to_image": { "type": "array", "items": { "type": "object", "title": "Image to image", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the image to image guidance" } }, "description": "Image to image guidance object, containing parameters available for image to image guidance" }, "title": "Image to Image", "description": "Creative reinterpretation of vibe or structure from a reference image.", "maxItems": 1 } } }, "style_ids": { "type": "array", "items": { "enum": [ "debdf72a-91a4-467b-bf61-cc02bdeb69c6", "9fdc5e8c-4d13-49b4-9ce6-5a74cbb19177", "a5632c7c-ddbb-4e2f-ba34-8456ab3ac436", "33abbb99-03b9-4dd7-9761-ee98650b2c88", "6fedbf1f-4a17-45ec-84fb-92fe524a29ef", "111dc692-d470-4eec-b791-3475abac4c46", "594c4a08-a522-4e0e-b7ff-e4dac4b6b622", "2e74ec31-f3a4-4825-b08b-2894f6d13941", "1fbb6a68-9319-44d2-8d56-2957ca0ece6a", "645e4195-f63d-4715-a3f2-3fb1e6eb8c70", "30c1d34f-e3a9-479a-b56f-c018bbc9c02a", "cadc8cd6-7838-4c99-b645-df76be8ba8d8", "621e1c9a-6319-4bee-a12d-ae40659162fa", "ab5a4220-7c42-41e5-a578-eddb9fed3d75", "22a9a7d2-2166-4d86-80ff-22e2643adbcf", "7c3f932b-a572-47cb-9b9b-f20211e63b5b", "581ba6d6-5aac-4492-bebe-54c424a0d46e", "b504f83c-3326-4947-82e1-7fe9e839ec0f", "be8c6b58-739c-4d44-b9c1-b032ed308b61", "093accc3-7633-4ffd-82da-d34000dfc0d6", "5bdc3f2a-1be6-4d1c-8e77-992a30824a2c", "dee282d3-891f-4f73-ba02-7f8131e5541b", "556c1ee5-ec38-42e8-955a-1e82dad0ffa1" ], "type": "string", "format": "uuid" }, "title": "Style IDs for Image Models", "default": [ "111dc692-d470-4eec-b791-3475abac4c46" ], "description": "An array of style UUIDs for image models (limited to 1 style)." }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" }, "negative_prompt": { "type": "string", "title": "Negative Prompt", "maxLength": 1000, "description": "The negative prompt to use for the generation" } }, "description": "Phoenix 1.0 Model Parameters" } }, "example": { "model": "phoenix-v1.0", "parameters": { "mode": "FAST", "width": 1024, "height": 1024, "prompt": "your prompt here", "quantity": 4, "style_ids": [ "111dc692-d470-4eec-b791-3475abac4c46" ] } } }, "KinoXlGenerationRequest": { "title": "Cinematic Kino", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "kino-xl" ], "description": "Must be `kino-xl`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt" ], "properties": { "mode": { "type": "string", "title": "Generation Mode", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Use this instead of `quality` for all proprietary models!", "enum": [ "FAST", "QUALITY" ], "anyOf": [ { "enum": [ "FAST" ] }, { "enum": [ "QUALITY" ] } ], "default": "FAST" }, "seed": { "type": "integer", "title": "Seed", "description": "The seed value for generation", "minimum": 0 }, "width": { "type": "integer", "title": "Width", "maximum": 1536, "minimum": 32, "description": "The width of the image to generate in pixels", "default": 1024, "multipleOf": 8 }, "height": { "type": "integer", "title": "Height", "maximum": 1536, "minimum": 32, "description": "The height of the image to generate in pixels", "default": 1024, "multipleOf": 8 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "tiling": { "type": "boolean", "title": "Tiling" }, "contrast": { "enum": [ "LOW", "MEDIUM", "HIGH" ], "type": "string", "title": "Contrast", "default": "MEDIUM", "description": "The contrast the image should have" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 4, "maximum": 8 }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "properties": { "edge": { "type": "array", "items": { "type": "object", "title": "Edge to Image guidance", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Edge to Image guidance object — detects edges in the input image and uses them to guide generation" }, "title": "Edge to Image", "description": "Detects edges of any input image, and will use this to guide your image generation.", "maxItems": 1 }, "pose": { "type": "array", "items": { "type": "object", "title": "Pose to Image guidance", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Pose to Image guidance object — detects the pose of characters in the input image and uses it to guide generation" }, "title": "Pose to Image", "description": "Detects the pose of any characters in an input image, and will use this to guide your image generation.", "maxItems": 1 }, "depth": { "type": "array", "items": { "type": "object", "title": "Depth to Image guidance", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Depth to Image guidance — detects the depth features of the input image and uses them to guide generation" }, "title": "Depth to Image", "description": "Detects the depth features of any input image, and will use this to guide your image generation.", "maxItems": 1 }, "style": { "type": "array", "items": { "type": "object", "title": "Style reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH", "ULTRA", "MAX" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Style transfer guidance object, containing parameters available for style transfer image guidance" }, "title": "Style Reference", "description": "References the style from the input image to guide your image generation.", "maxItems": 4 }, "content": { "type": "array", "items": { "type": "object", "title": "Content reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH", "ULTRA" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Content transfer guidance object, containing parameters available for content transfer image guidance" }, "title": "Content Reference", "description": "References the form and content from the input image to guide your image generation.", "maxItems": 1 }, "character": { "type": "array", "items": { "type": "object", "title": "Character reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Character transfer guidance object, containing parameters available for character transfer image guidance" }, "title": "Content Reference", "description": "Generates an image in the likeness of the provided character reference image (works best with close up face portraits).", "maxItems": 1 }, "text_image": { "type": "array", "items": { "type": "object", "title": "Text Image Input guidance", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Text Image Input guidance — takes white text on a black background and uses it to guide image generation" }, "title": "Text Image Input", "description": "Takes in white text on a black background, and will use this to guide your image generation.", "maxItems": 1 }, "image_to_image": { "type": "array", "items": { "type": "object", "title": "Image to image", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the image to image guidance" } }, "description": "Image to image guidance object, containing parameters available for image to image guidance" }, "title": "Image to Image", "description": "Creative reinterpretation of vibe or structure from a reference image.", "maxItems": 1 } } }, "style_ids": { "type": "array", "items": { "enum": [ "a5632c7c-ddbb-4e2f-ba34-8456ab3ac436", "9fdc5e8c-4d13-49b4-9ce6-5a74cbb19177", "cc53f935-884c-40a0-b7eb-1f5c42821fb5", "6fedbf1f-4a17-45ec-84fb-92fe524a29ef", "594c4a08-a522-4e0e-b7ff-e4dac4b6b622", "85da2dcc-c373-464c-9a7a-5624359be859", "d574325d-1278-43fc-9159-e8ff2154e9f7", "97c20e5c-1af6-4d42-b227-54d03d8f0727", "b220bdb6-1378-43fc-9159-e8ff2154e9f7", "30c1d34f-e3a9-479a-b56f-c018bbc9c02a", "cadc8cd6-7838-4c99-b645-df76be8ba8d8", "a2f7ea66-959b-4bbe-b508-6133238b76b6", "621e1c9a-6319-4bee-a12d-ae40659162fa", "0d914779-c822-430a-b976-30075033f1c4", "6105baa2-851b-446e-9db5-08a671a8c42f", "5bdc3f2a-1be6-4d1c-8e77-992a30824a2c", "62736842-6e4b-4028-b79a-4f1a1606e893", "dee282d3-891f-4f73-ba02-7f8131e5541b", "111dc692-d470-4eec-b791-3475abac4c46", "ab5a4220-7c42-41e5-a578-eddb9fed3d75", "556c1ee5-ec38-42e8-955a-1e82dad0ffa1" ], "type": "string", "format": "uuid" }, "title": "Style IDs for Image Models", "default": [ "a5632c7c-ddbb-4e2f-ba34-8456ab3ac436" ], "description": "An array of style UUIDs for image models (limited to 1 style)." }, "transparency": { "type": "boolean", "title": "Transparency", "description": "Whether the image can be generated with a transparent background", "default": false }, "user_elements": { "type": "array", "items": { "properties": { "weight": { "minimum": 0 } } }, "title": "Your Elements", "default": [], "description": "An array of User Elements for image generation.", "maxItems": 4 }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "OFF", "description": "Whether to enhance the prompt or not" }, "negative_prompt": { "type": "string", "title": "Negative Prompt", "maxLength": 1000, "description": "The negative prompt to use for the generation" }, "platform_elements": { "type": "array", "items": { "properties": { "weight": { "minimum": 0 } } }, "title": "Platform Elements", "default": [], "description": "An array of Platform Elements for image generation.", "maxItems": 4 } } } }, "example": { "model": "kino-xl", "parameters": { "mode": "FAST", "width": 1024, "height": 1024, "prompt": "your prompt here", "contrast": "MEDIUM", "quantity": 4, "style_ids": [ "a5632c7c-ddbb-4e2f-ba34-8456ab3ac436" ], "transparency": false, "prompt_enhance": "OFF" } } }, "AnimeXlGenerationRequest": { "title": "Anime", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "anime-xl" ], "description": "Must be `anime-xl`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt" ], "properties": { "mode": { "type": "string", "title": "Generation Mode", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Use this instead of `quality` for all proprietary models!", "enum": [ "FAST", "QUALITY" ], "anyOf": [ { "enum": [ "FAST" ] }, { "enum": [ "QUALITY" ] } ], "default": "FAST" }, "seed": { "type": "integer", "title": "Seed", "description": "The seed value for generation", "minimum": 0 }, "width": { "type": "integer", "title": "Width", "maximum": 1584, "minimum": 32, "description": "The width of the image to generate in pixels", "default": 1024, "multipleOf": 8 }, "height": { "type": "integer", "title": "Height", "maximum": 1536, "minimum": 32, "description": "The height of the image to generate in pixels", "default": 1024, "multipleOf": 8 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "tiling": { "type": "boolean", "title": "Tiling" }, "contrast": { "enum": [ "LOW", "MEDIUM", "HIGH" ], "type": "string", "title": "Contrast", "default": "LOW", "description": "The contrast the image should have" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 4, "maximum": 8 }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "properties": { "edge": { "type": "array", "items": { "type": "object", "title": "Edge to Image guidance", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Edge to Image guidance object — detects edges in the input image and uses them to guide generation" }, "title": "Edge to Image", "description": "Detects edges of any input image, and will use this to guide your image generation.", "maxItems": 1 }, "pose": { "type": "array", "items": { "type": "object", "title": "Pose to Image guidance", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Pose to Image guidance object — detects the pose of characters in the input image and uses it to guide generation" }, "title": "Pose to Image", "description": "Detects the pose of any characters in an input image, and will use this to guide your image generation.", "maxItems": 1 }, "depth": { "type": "array", "items": { "type": "object", "title": "Depth to Image guidance", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Depth to Image guidance — detects the depth features of the input image and uses them to guide generation" }, "title": "Depth to Image", "description": "Detects the depth features of any input image, and will use this to guide your image generation.", "maxItems": 1 }, "style": { "type": "array", "items": { "type": "object", "title": "Style reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH", "ULTRA", "MAX" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Style transfer guidance object, containing parameters available for style transfer image guidance" }, "title": "Style Reference", "description": "References the style from the input image to guide your image generation.", "maxItems": 4 }, "content": { "type": "array", "items": { "type": "object", "title": "Content reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH", "ULTRA" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Content transfer guidance object, containing parameters available for content transfer image guidance" }, "title": "Content Reference", "description": "References the form and content from the input image to guide your image generation.", "maxItems": 1 }, "character": { "type": "array", "items": { "type": "object", "title": "Character reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Character transfer guidance object, containing parameters available for character transfer image guidance" }, "title": "Content Reference", "description": "Generates an image in the likeness of the provided character reference image (works best with close up face portraits).", "maxItems": 1 }, "text_image": { "type": "array", "items": { "type": "object", "title": "Text Image Input guidance", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Text Image Input guidance — takes white text on a black background and uses it to guide image generation" }, "title": "Text Image Input", "description": "Takes in white text on a black background, and will use this to guide your image generation.", "maxItems": 1 }, "image_to_image": { "type": "array", "items": { "type": "object", "title": "Image to image", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the image to image guidance" } }, "description": "Image to image guidance object, containing parameters available for image to image guidance" }, "title": "Image to Image", "description": "Creative reinterpretation of vibe or structure from a reference image.", "maxItems": 1 } } }, "style_ids": { "type": "array", "items": { "enum": [ "32b653d2-8819-4363-bc82-a6466dfcb825", "5f611024-668e-41cc-b538-4569a7985cad", "df2def02-1104-46c8-a857-39292fcd9091", "aab2fcb9-3600-4039-9c25-a2a26515df5f", "1824f984-dc0b-4f72-aa32-0442091d488c", "16818741-bdbb-474f-a7a8-1e33d706658e", "bf0b8b5f-735f-4141-a365-8d8aa78fd147", "5d256598-5671-424c-8152-27943f1000f1", "726585f5-d231-4a3a-bee9-9a5e5d3df779", "b2a54a51-230b-4d4f-ad4e-8409bf58645f", "ca934804-ef39-4e1b-af37-608021452444", "e89ca6f0-7653-4db6-8a24-ded9d1267d84" ], "type": "string", "format": "uuid" }, "title": "Style IDs for Image Models", "default": [ "b2a54a51-230b-4d4f-ad4e-8409bf58645f" ], "description": "An array of style UUIDs for image models (limited to 1 style)." }, "transparency": { "type": "boolean", "title": "Transparency", "description": "Whether the image can be generated with a transparent background", "default": false }, "user_elements": { "type": "array", "items": { "properties": { "weight": { "minimum": 0 } } }, "title": "Your Elements", "default": [], "description": "An array of User Elements for image generation.", "maxItems": 4 }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "OFF", "description": "Whether to enhance the prompt or not" }, "negative_prompt": { "type": "string", "title": "Negative Prompt", "maxLength": 1000, "description": "The negative prompt to use for the generation" }, "platform_elements": { "type": "array", "items": { "properties": { "weight": { "minimum": 0 } } }, "title": "Platform Elements", "default": [], "description": "An array of Platform Elements for image generation.", "maxItems": 4 } } } }, "example": { "model": "anime-xl", "parameters": { "mode": "FAST", "width": 1024, "height": 1024, "prompt": "your prompt here", "contrast": "LOW", "quantity": 4, "style_ids": [ "b2a54a51-230b-4d4f-ad4e-8409bf58645f" ], "transparency": false, "prompt_enhance": "OFF" } } }, "PortraitPerfectGenerationRequest": { "title": "Portrait Perfect", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "portrait-perfect" ], "description": "Must be `portrait-perfect`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt" ], "properties": { "mode": { "type": "string", "title": "Generation Mode", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Use this instead of `quality` for all proprietary models!", "enum": [ "FAST", "QUALITY" ], "anyOf": [ { "enum": [ "FAST" ] }, { "enum": [ "QUALITY" ] } ], "default": "QUALITY" }, "seed": { "type": "integer", "title": "Seed", "description": "The seed value for generation", "minimum": 0 }, "width": { "type": "integer", "title": "Width", "maximum": 1536, "minimum": 32, "description": "The width of the image to generate in pixels", "default": 1024, "multipleOf": 8 }, "height": { "type": "integer", "title": "Height", "maximum": 1536, "minimum": 32, "description": "The height of the image to generate in pixels", "default": 1024, "multipleOf": 8 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "tiling": { "type": "boolean", "title": "Tiling" }, "contrast": { "enum": [ "LOW", "MEDIUM", "HIGH" ], "type": "string", "title": "Contrast", "default": "MEDIUM", "description": "The contrast the image should have" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 4, "maximum": 8 }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "properties": { "edge": { "type": "array", "items": { "type": "object", "title": "Edge to Image guidance", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Edge to Image guidance object — detects edges in the input image and uses them to guide generation" }, "title": "Edge to Image", "description": "Detects edges of any input image, and will use this to guide your image generation.", "maxItems": 1 }, "pose": { "type": "array", "items": { "type": "object", "title": "Pose to Image guidance", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Pose to Image guidance object — detects the pose of characters in the input image and uses it to guide generation" }, "title": "Pose to Image", "description": "Detects the pose of any characters in an input image, and will use this to guide your image generation.", "maxItems": 1 }, "depth": { "type": "array", "items": { "type": "object", "title": "Depth to Image guidance", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Depth to Image guidance — detects the depth features of the input image and uses them to guide generation" }, "title": "Depth to Image", "description": "Detects the depth features of any input image, and will use this to guide your image generation.", "maxItems": 1 }, "style": { "type": "array", "items": { "type": "object", "title": "Style reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH", "ULTRA", "MAX" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Style transfer guidance object, containing parameters available for style transfer image guidance" }, "title": "Style Reference", "description": "References the style from the input image to guide your image generation.", "maxItems": 4 }, "content": { "type": "array", "items": { "type": "object", "title": "Content reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH", "ULTRA" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Content transfer guidance object, containing parameters available for content transfer image guidance" }, "title": "Content Reference", "description": "References the form and content from the input image to guide your image generation.", "maxItems": 1 }, "character": { "type": "array", "items": { "type": "object", "title": "Character reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Character transfer guidance object, containing parameters available for character transfer image guidance" }, "title": "Content Reference", "description": "Generates an image in the likeness of the provided character reference image (works best with close up face portraits).", "maxItems": 1 }, "text_image": { "type": "array", "items": { "type": "object", "title": "Text Image Input guidance", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Text Image Input guidance — takes white text on a black background and uses it to guide image generation" }, "title": "Text Image Input", "description": "Takes in white text on a black background, and will use this to guide your image generation.", "maxItems": 1 }, "image_to_image": { "type": "array", "items": { "type": "object", "title": "Image to image", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the image to image guidance" } }, "description": "Image to image guidance object, containing parameters available for image to image guidance" }, "title": "Image to Image", "description": "Creative reinterpretation of vibe or structure from a reference image.", "maxItems": 1 } } }, "style_ids": { "type": "array", "items": { "enum": [ "4edb03c9-8a26-4041-9d01-f85b5d4abd71", "d4fb14b9-972b-4215-b461-616a51b6eeb8", "c9b08088-f497-4e30-b258-6d535d928cc5", "0717967c-1a32-4c67-bc56-b020e97b1b81", "39a14739-5d21-420b-a4ef-e8a80978185a", "3e645868-7d35-4b8c-974c-10bd8c2de972", "0d34f8e1-46d4-428f-8ddd-4b11811fa7c9", "556c1ee5-ec38-42e8-955a-1e82dad0ffa1" ], "type": "string", "format": "uuid" }, "title": "Style IDs for Image Models", "default": [ "4edb03c9-8a26-4041-9d01-f85b5d4abd71" ], "description": "An array of style UUIDs for image models (limited to 1 style)." }, "transparency": { "type": "boolean", "title": "Transparency", "description": "Whether the image can be generated with a transparent background", "default": false }, "user_elements": { "type": "array", "items": { "properties": { "weight": { "minimum": 0 } } }, "title": "Your Elements", "default": [], "description": "An array of User Elements for image generation.", "maxItems": 4 }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "OFF", "description": "Whether to enhance the prompt or not" }, "negative_prompt": { "type": "string", "title": "Negative Prompt", "maxLength": 1000, "description": "The negative prompt to use for the generation" }, "platform_elements": { "type": "array", "items": { "properties": { "weight": { "minimum": 0 } } }, "title": "Platform Elements", "default": [], "description": "An array of Platform Elements for image generation.", "maxItems": 4 } } } }, "example": { "model": "portrait-perfect", "parameters": { "mode": "QUALITY", "width": 1024, "height": 1024, "prompt": "your prompt here", "quantity": 4, "style_ids": [ "4edb03c9-8a26-4041-9d01-f85b5d4abd71" ], "transparency": false, "prompt_enhance": "OFF" } } }, "StockPhotographyGenerationRequest": { "title": "Stock Photography", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "stock-photography" ], "description": "Must be `stock-photography`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt" ], "properties": { "mode": { "type": "string", "title": "Generation Mode", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Use this instead of `quality` for all proprietary models!", "enum": [ "FAST", "QUALITY" ], "anyOf": [ { "enum": [ "FAST" ] }, { "enum": [ "QUALITY" ] } ], "default": "QUALITY" }, "seed": { "type": "integer", "title": "Seed", "description": "The seed value for generation", "minimum": 0 }, "width": { "type": "integer", "title": "Width", "maximum": 1536, "minimum": 32, "description": "The width of the image to generate in pixels", "default": 1024, "multipleOf": 8 }, "height": { "type": "integer", "title": "Height", "maximum": 1536, "minimum": 32, "description": "The height of the image to generate in pixels", "default": 1024, "multipleOf": 8 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "tiling": { "type": "boolean", "title": "Tiling" }, "contrast": { "enum": [ "LOW", "MEDIUM", "HIGH" ], "type": "string", "title": "Contrast", "default": "MEDIUM", "description": "The contrast the image should have" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 4, "maximum": 8 }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "properties": { "edge": { "type": "array", "items": { "type": "object", "title": "Edge to Image guidance", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Edge to Image guidance object — detects edges in the input image and uses them to guide generation" }, "title": "Edge to Image", "description": "Detects edges of any input image, and will use this to guide your image generation.", "maxItems": 1 }, "pose": { "type": "array", "items": { "type": "object", "title": "Pose to Image guidance", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Pose to Image guidance object — detects the pose of characters in the input image and uses it to guide generation" }, "title": "Pose to Image", "description": "Detects the pose of any characters in an input image, and will use this to guide your image generation.", "maxItems": 1 }, "depth": { "type": "array", "items": { "type": "object", "title": "Depth to Image guidance", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Depth to Image guidance — detects the depth features of the input image and uses them to guide generation" }, "title": "Depth to Image", "description": "Detects the depth features of any input image, and will use this to guide your image generation.", "maxItems": 1 }, "style": { "type": "array", "items": { "type": "object", "title": "Style reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH", "ULTRA", "MAX" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Style transfer guidance object, containing parameters available for style transfer image guidance" }, "title": "Style Reference", "description": "References the style from the input image to guide your image generation.", "maxItems": 4 }, "content": { "type": "array", "items": { "type": "object", "title": "Content reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH", "ULTRA" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Content transfer guidance object, containing parameters available for content transfer image guidance" }, "title": "Content Reference", "description": "References the form and content from the input image to guide your image generation.", "maxItems": 1 }, "character": { "type": "array", "items": { "type": "object", "title": "Character reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Character transfer guidance object, containing parameters available for character transfer image guidance" }, "title": "Content Reference", "description": "Generates an image in the likeness of the provided character reference image (works best with close up face portraits).", "maxItems": 1 }, "text_image": { "type": "array", "items": { "type": "object", "title": "Text Image Input guidance", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Text Image Input guidance — takes white text on a black background and uses it to guide image generation" }, "title": "Text Image Input", "description": "Takes in white text on a black background, and will use this to guide your image generation.", "maxItems": 1 }, "image_to_image": { "type": "array", "items": { "type": "object", "title": "Image to image", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the image to image guidance" } }, "description": "Image to image guidance object, containing parameters available for image to image guidance" }, "title": "Image to Image", "description": "Creative reinterpretation of vibe or structure from a reference image.", "maxItems": 1 } } }, "style_ids": { "type": "array", "items": { "enum": [ "5bdc3f2a-1be6-4d1c-8e77-992a30824a2c", "556c1ee5-ec38-42e8-955a-1e82dad0ffa1" ], "type": "string", "format": "uuid" }, "title": "Style IDs for Image Models", "default": [ "5bdc3f2a-1be6-4d1c-8e77-992a30824a2c" ], "description": "An array of style UUIDs for image models (limited to 1 style)." }, "transparency": { "type": "boolean", "title": "Transparency", "description": "Whether the image can be generated with a transparent background", "default": false }, "user_elements": { "type": "array", "items": { "properties": { "weight": { "minimum": 0 } } }, "title": "Your Elements", "default": [], "description": "An array of User Elements for image generation.", "maxItems": 4 }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "OFF", "description": "Whether to enhance the prompt or not" }, "negative_prompt": { "type": "string", "title": "Negative Prompt", "maxLength": 1000, "description": "The negative prompt to use for the generation" }, "platform_elements": { "type": "array", "items": { "properties": { "weight": { "minimum": 0 } } }, "title": "Platform Elements", "default": [], "description": "An array of Platform Elements for image generation.", "maxItems": 4 } } } }, "example": { "model": "stock-photography", "parameters": { "mode": "QUALITY", "width": 1024, "height": 1024, "prompt": "your prompt here", "contrast": "MEDIUM", "quantity": 4, "style_ids": [ "5bdc3f2a-1be6-4d1c-8e77-992a30824a2c" ], "transparency": false, "prompt_enhance": "OFF" } } }, "IllustrativeAlbedoGenerationRequest": { "title": "Illustrative Albedo", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "illustrative-albedo" ], "description": "Must be `illustrative-albedo`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt" ], "properties": { "mode": { "type": "string", "title": "Generation Mode", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Use this instead of `quality` for all proprietary models!", "enum": [ "FAST", "QUALITY" ], "anyOf": [ { "enum": [ "FAST" ] }, { "enum": [ "QUALITY" ] } ], "default": "FAST" }, "seed": { "type": "integer", "title": "Seed", "description": "The seed value for generation", "minimum": 0 }, "width": { "type": "integer", "title": "Width", "maximum": 1584, "minimum": 32, "description": "The width of the image to generate in pixels", "default": 1024, "multipleOf": 8 }, "height": { "type": "integer", "title": "Height", "maximum": 1536, "minimum": 32, "description": "The height of the image to generate in pixels", "default": 1024, "multipleOf": 8 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "tiling": { "type": "boolean", "title": "Tiling" }, "contrast": { "enum": [ "LOW", "MEDIUM", "HIGH" ], "type": "string", "title": "Contrast", "default": "MEDIUM", "description": "The contrast the image should have" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 4, "maximum": 8 }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "properties": { "edge": { "type": "array", "items": { "type": "object", "title": "Edge to Image guidance", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Edge to Image guidance object — detects edges in the input image and uses them to guide generation" }, "title": "Edge to Image", "description": "Detects edges of any input image, and will use this to guide your image generation.", "maxItems": 1 }, "pose": { "type": "array", "items": { "type": "object", "title": "Pose to Image guidance", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Pose to Image guidance object — detects the pose of characters in the input image and uses it to guide generation" }, "title": "Pose to Image", "description": "Detects the pose of any characters in an input image, and will use this to guide your image generation.", "maxItems": 1 }, "depth": { "type": "array", "items": { "type": "object", "title": "Depth to Image guidance", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Depth to Image guidance — detects the depth features of the input image and uses them to guide generation" }, "title": "Depth to Image", "description": "Detects the depth features of any input image, and will use this to guide your image generation.", "maxItems": 1 }, "style": { "type": "array", "items": { "type": "object", "title": "Style reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH", "ULTRA", "MAX" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Style transfer guidance object, containing parameters available for style transfer image guidance" }, "title": "Style Reference", "description": "References the style from the input image to guide your image generation.", "maxItems": 4 }, "content": { "type": "array", "items": { "type": "object", "title": "Content reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH", "ULTRA" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Content transfer guidance object, containing parameters available for content transfer image guidance" }, "title": "Content Reference", "description": "References the form and content from the input image to guide your image generation.", "maxItems": 1 }, "character": { "type": "array", "items": { "type": "object", "title": "Character reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Character transfer guidance object, containing parameters available for character transfer image guidance" }, "title": "Content Reference", "description": "Generates an image in the likeness of the provided character reference image (works best with close up face portraits).", "maxItems": 1 }, "text_image": { "type": "array", "items": { "type": "object", "title": "Text Image Input guidance", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Text Image Input guidance — takes white text on a black background and uses it to guide image generation" }, "title": "Text Image Input", "description": "Takes in white text on a black background, and will use this to guide your image generation.", "maxItems": 1 }, "image_to_image": { "type": "array", "items": { "type": "object", "title": "Image to image", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the image to image guidance" } }, "description": "Image to image guidance object, containing parameters available for image to image guidance" }, "title": "Image to Image", "description": "Creative reinterpretation of vibe or structure from a reference image.", "maxItems": 1 } } }, "style_ids": { "type": "array", "items": { "enum": [ "645e4195-f63d-4715-a3f2-3fb1e6eb8c70", "debdf72a-91a4-467b-bf61-cc02bdeb69c6", "b504f83c-3326-4947-82e1-7fe9e839ec0f", "6e13a467-7dde-415a-8020-0ce2b27bc4e8", "621e1c9a-6319-4bee-a12d-ae40659162fa", "ab5a4220-7c42-41e5-a578-eddb9fed3d75", "b2a54a51-230b-4d4f-ad4e-8409bf58645f", "e4d8224a-d804-4b00-b383-b1f3213b9faf", "5e931eed-1ab9-48a0-aad0-ea5c7d13d472", "cadc8cd6-7838-4c99-b645-df76be8ba8d8", "d574325d-1278-4fe2-974b-768525f253c3", "fed4e15f-84b3-4f6e-9b20-9d3a3798eab8", "be8c6b58-739c-4d44-b9c1-b032ed308b61", "093accc3-7633-4ffd-82da-d34000dfc0d6", "111dc692-d470-4eec-b791-3475abac4c46", "556c1ee5-ec38-42e8-955a-1e82dad0ffa1" ], "type": "string", "format": "uuid" }, "title": "Style IDs for Image Models", "default": [ "645e4195-f63d-4715-a3f2-3fb1e6eb8c70" ], "description": "An array of style UUIDs for image models (limited to 1 style)." }, "transparency": { "type": "boolean", "title": "Transparency", "description": "Whether the image can be generated with a transparent background", "default": false }, "user_elements": { "type": "array", "items": { "properties": { "weight": { "minimum": 0 } } }, "title": "Your Elements", "default": [], "description": "An array of User Elements for image generation.", "maxItems": 4 }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "OFF", "description": "Whether to enhance the prompt or not" }, "negative_prompt": { "type": "string", "title": "Negative Prompt", "maxLength": 1000, "description": "The negative prompt to use for the generation" }, "platform_elements": { "type": "array", "items": { "properties": { "weight": { "minimum": 0 } } }, "title": "Platform Elements", "default": [], "description": "An array of Platform Elements for image generation.", "maxItems": 4 } } } }, "example": { "model": "illustrative-albedo", "parameters": { "mode": "FAST", "width": 1024, "height": 1024, "prompt": "your prompt here", "quantity": 4, "style_ids": [ "645e4195-f63d-4715-a3f2-3fb1e6eb8c70" ], "transparency": false, "prompt_enhance": "OFF" } } }, "ConceptArtGenerationRequest": { "title": "Concept Art", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "concept-art" ], "description": "Must be `concept-art`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt" ], "properties": { "mode": { "type": "string", "title": "Generation Mode", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Use this instead of `quality` for all proprietary models!", "enum": [ "FAST", "QUALITY" ], "anyOf": [ { "enum": [ "FAST" ] }, { "enum": [ "QUALITY" ] } ], "default": "FAST" }, "seed": { "type": "integer", "title": "Seed", "description": "The seed value for generation", "minimum": 0 }, "width": { "type": "integer", "title": "Width", "maximum": 1584, "minimum": 32, "description": "The width of the image to generate in pixels", "default": 1024, "multipleOf": 8 }, "height": { "type": "integer", "title": "Height", "maximum": 1536, "minimum": 32, "description": "The height of the image to generate in pixels", "default": 1024, "multipleOf": 8 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "tiling": { "type": "boolean", "title": "Tiling" }, "contrast": { "enum": [ "LOW", "MEDIUM", "HIGH" ], "type": "string", "title": "Contrast", "default": "MEDIUM", "description": "The contrast the image should have" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 4, "maximum": 8 }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "properties": { "edge": { "type": "array", "items": { "type": "object", "title": "Edge to Image guidance", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Edge to Image guidance object — detects edges in the input image and uses them to guide generation" }, "title": "Edge to Image", "description": "Detects edges of any input image, and will use this to guide your image generation.", "maxItems": 1 }, "pose": { "type": "array", "items": { "type": "object", "title": "Pose to Image guidance", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Pose to Image guidance object — detects the pose of characters in the input image and uses it to guide generation" }, "title": "Pose to Image", "description": "Detects the pose of any characters in an input image, and will use this to guide your image generation.", "maxItems": 1 }, "depth": { "type": "array", "items": { "type": "object", "title": "Depth to Image guidance", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Depth to Image guidance — detects the depth features of the input image and uses them to guide generation" }, "title": "Depth to Image", "description": "Detects the depth features of any input image, and will use this to guide your image generation.", "maxItems": 1 }, "style": { "type": "array", "items": { "type": "object", "title": "Style reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH", "ULTRA", "MAX" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Style transfer guidance object, containing parameters available for style transfer image guidance" }, "title": "Style Reference", "description": "References the style from the input image to guide your image generation.", "maxItems": 4 }, "content": { "type": "array", "items": { "type": "object", "title": "Content reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH", "ULTRA" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Content transfer guidance object, containing parameters available for content transfer image guidance" }, "title": "Content Reference", "description": "References the form and content from the input image to guide your image generation.", "maxItems": 1 }, "character": { "type": "array", "items": { "type": "object", "title": "Character reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Character transfer guidance object, containing parameters available for character transfer image guidance" }, "title": "Content Reference", "description": "Generates an image in the likeness of the provided character reference image (works best with close up face portraits).", "maxItems": 1 }, "text_image": { "type": "array", "items": { "type": "object", "title": "Text Image Input guidance", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Text Image Input guidance — takes white text on a black background and uses it to guide image generation" }, "title": "Text Image Input", "description": "Takes in white text on a black background, and will use this to guide your image generation.", "maxItems": 1 }, "image_to_image": { "type": "array", "items": { "type": "object", "title": "Image to image", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the image to image guidance" } }, "description": "Image to image guidance object, containing parameters available for image to image guidance" }, "title": "Image to Image", "description": "Creative reinterpretation of vibe or structure from a reference image.", "maxItems": 1 } } }, "style_ids": { "type": "array", "items": { "enum": [ "726585f5-d231-4a3a-bee9-9a5e5d3df779", "5d256598-5671-424c-8152-27943f1000f1", "09d2b5b5-d7c5-4c02-905d-9f84051640f4", "6e13a467-7dde-415a-8020-0ce2b27bc4e8", "33abbb99-03b9-4dd7-9761-ee98650b2c88", "fed4e15f-84b3-4f6e-9b20-9d3a3798eab8", "5e931eed-1ab9-48a0-aad0-ea5c7d13d472", "e4d8224a-d804-4b00-b383-b1f3213b9faf" ], "type": "string", "format": "uuid" }, "title": "Style IDs for Image Models", "default": [ "726585f5-d231-4a3a-bee9-9a5e5d3df779" ], "description": "An array of style UUIDs for image models (limited to 1 style)." }, "transparency": { "type": "boolean", "title": "Transparency", "description": "Whether the image can be generated with a transparent background", "default": false }, "user_elements": { "type": "array", "items": { "properties": { "weight": { "minimum": 0 } } }, "title": "Your Elements", "default": [], "description": "An array of User Elements for image generation.", "maxItems": 4 }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "OFF", "description": "Whether to enhance the prompt or not" }, "negative_prompt": { "type": "string", "title": "Negative Prompt", "maxLength": 1000, "description": "The negative prompt to use for the generation" }, "platform_elements": { "type": "array", "items": { "properties": { "weight": { "minimum": 0 } } }, "title": "Platform Elements", "default": [], "description": "An array of Platform Elements for image generation.", "maxItems": 4 } } } }, "example": { "model": "concept-art", "parameters": { "mode": "FAST", "width": 1024, "height": 1024, "prompt": "your prompt here", "quantity": 4, "style_ids": [ "726585f5-d231-4a3a-bee9-9a5e5d3df779" ], "transparency": false, "prompt_enhance": "OFF" } } }, "LifelikeVisionGenerationRequest": { "title": "Lifelike Vision", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "lifelike-vision" ], "description": "Must be `lifelike-vision`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt" ], "properties": { "mode": { "type": "string", "title": "Generation Mode", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Use this instead of `quality` for all proprietary models!", "enum": [ "FAST", "QUALITY" ], "anyOf": [ { "enum": [ "FAST" ] }, { "enum": [ "QUALITY" ] } ], "default": "FAST" }, "seed": { "type": "integer", "title": "Seed", "description": "The seed value for generation", "minimum": 0 }, "width": { "type": "integer", "title": "Width", "maximum": 1584, "minimum": 32, "description": "The width of the image to generate in pixels", "default": 1024, "multipleOf": 8 }, "height": { "type": "integer", "title": "Height", "maximum": 1536, "minimum": 32, "description": "The height of the image to generate in pixels", "default": 1024, "multipleOf": 8 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "tiling": { "type": "boolean", "title": "Tiling" }, "contrast": { "enum": [ "LOW", "MEDIUM", "HIGH" ], "type": "string", "title": "Contrast", "default": "MEDIUM", "description": "The contrast the image should have" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 4, "maximum": 8 }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "properties": { "edge": { "type": "array", "items": { "type": "object", "title": "Edge to Image guidance", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Edge to Image guidance object — detects edges in the input image and uses them to guide generation" }, "title": "Edge to Image", "description": "Detects edges of any input image, and will use this to guide your image generation.", "maxItems": 1 }, "pose": { "type": "array", "items": { "type": "object", "title": "Pose to Image guidance", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Pose to Image guidance object — detects the pose of characters in the input image and uses it to guide generation" }, "title": "Pose to Image", "description": "Detects the pose of any characters in an input image, and will use this to guide your image generation.", "maxItems": 1 }, "depth": { "type": "array", "items": { "type": "object", "title": "Depth to Image guidance", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Depth to Image guidance — detects the depth features of the input image and uses them to guide generation" }, "title": "Depth to Image", "description": "Detects the depth features of any input image, and will use this to guide your image generation.", "maxItems": 1 }, "style": { "type": "array", "items": { "type": "object", "title": "Style reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH", "ULTRA", "MAX" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Style transfer guidance object, containing parameters available for style transfer image guidance" }, "title": "Style Reference", "description": "References the style from the input image to guide your image generation.", "maxItems": 4 }, "content": { "type": "array", "items": { "type": "object", "title": "Content reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH", "ULTRA" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Content transfer guidance object, containing parameters available for content transfer image guidance" }, "title": "Content Reference", "description": "References the form and content from the input image to guide your image generation.", "maxItems": 1 }, "character": { "type": "array", "items": { "type": "object", "title": "Character reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Character transfer guidance object, containing parameters available for character transfer image guidance" }, "title": "Content Reference", "description": "Generates an image in the likeness of the provided character reference image (works best with close up face portraits).", "maxItems": 1 }, "text_image": { "type": "array", "items": { "type": "object", "title": "Text Image Input guidance", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Text Image Input guidance — takes white text on a black background and uses it to guide image generation" }, "title": "Text Image Input", "description": "Takes in white text on a black background, and will use this to guide your image generation.", "maxItems": 1 }, "image_to_image": { "type": "array", "items": { "type": "object", "title": "Image to image", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the image to image guidance" } }, "description": "Image to image guidance object, containing parameters available for image to image guidance" }, "title": "Image to Image", "description": "Creative reinterpretation of vibe or structure from a reference image.", "maxItems": 1 } } }, "style_ids": { "type": "array", "items": { "enum": [ "6fedbf1f-4a17-45ec-84fb-92fe524a29ef", "debdf72a-91a4-467b-bf61-cc02bdeb69c6", "a5632c7c-ddbb-4e2f-ba34-8456ab3ac436", "ab5a4220-7c42-41e5-a578-eddb9fed3d75", "645e4195-f63d-4715-a3f2-3fb1e6eb8c70", "594c4a08-a522-4e0e-b7ff-e4dac4b6b622", "dee282d3-891f-4f73-ba02-7f8131e5541b", "b504f83c-3326-4947-82e1-7fe9e839ec0f", "6105baa2-851b-446e-9db5-08a671a8c42f", "621e1c9a-6319-4bee-a12d-ae40659162fa", "a2f7ea66-959b-4bbe-b508-6133238b76b6", "cadc8cd6-7838-4c99-b645-df76be8ba8d8", "30c1d34f-e3a9-479a-b56f-c018bbc9c02a", "b220bdb6-1378-43fc-9159-e8ff2154e9f7", "85da2dcc-c373-464c-9a7a-5624359be859", "97c20e5c-1af6-4d42-b227-54d03d8f0727", "cc53f935-884c-40a0-b7eb-1f5c42821fb5", "9fdc5e8c-4d13-49b4-9ce6-5a74cbb19177", "111dc692-d470-4eec-b791-3475abac4c46", "556c1ee5-ec38-42e8-955a-1e82dad0ffa1" ], "type": "string", "format": "uuid" }, "title": "Style IDs for Image Models", "default": [ "111dc692-d470-4eec-b791-3475abac4c46" ], "description": "An array of style UUIDs for image models (limited to 1 style)." }, "transparency": { "type": "boolean", "title": "Transparency", "description": "Whether the image can be generated with a transparent background", "default": false }, "user_elements": { "type": "array", "items": { "properties": { "weight": { "minimum": 0 } } }, "title": "Your Elements", "default": [], "description": "An array of User Elements for image generation.", "maxItems": 4 }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "OFF", "description": "Whether to enhance the prompt or not" }, "negative_prompt": { "type": "string", "title": "Negative Prompt", "maxLength": 1000, "description": "The negative prompt to use for the generation" }, "platform_elements": { "type": "array", "items": { "properties": { "weight": { "minimum": 0 } } }, "title": "Platform Elements", "default": [], "description": "An array of Platform Elements for image generation.", "maxItems": 4 } } } }, "example": { "model": "lifelike-vision", "parameters": { "mode": "FAST", "width": 1024, "height": 1024, "prompt": "your prompt here", "quantity": 4, "style_ids": [ "111dc692-d470-4eec-b791-3475abac4c46" ], "transparency": false, "prompt_enhance": "OFF" } } }, "GraphicDesignGenerationRequest": { "title": "Graphic Design", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "graphic-design" ], "description": "Must be `graphic-design`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt" ], "properties": { "mode": { "type": "string", "title": "Generation Mode", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Use this instead of `quality` for all proprietary models!", "enum": [ "FAST", "QUALITY" ], "anyOf": [ { "enum": [ "FAST" ] }, { "enum": [ "QUALITY" ] } ], "default": "FAST" }, "seed": { "type": "integer", "title": "Seed", "description": "The seed value for generation", "minimum": 0 }, "width": { "type": "integer", "title": "Width", "maximum": 1584, "minimum": 32, "description": "The width of the image to generate in pixels", "default": 1024, "multipleOf": 8 }, "height": { "type": "integer", "title": "Height", "maximum": 1536, "minimum": 32, "description": "The height of the image to generate in pixels", "default": 1024, "multipleOf": 8 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "tiling": { "type": "boolean", "title": "Tiling" }, "contrast": { "enum": [ "LOW", "MEDIUM", "HIGH" ], "type": "string", "title": "Contrast", "default": "MEDIUM", "description": "The contrast the image should have" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 4, "maximum": 8 }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "properties": { "edge": { "type": "array", "items": { "type": "object", "title": "Edge to Image guidance", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Edge to Image guidance object — detects edges in the input image and uses them to guide generation" }, "title": "Edge to Image", "description": "Detects edges of any input image, and will use this to guide your image generation.", "maxItems": 1 }, "pose": { "type": "array", "items": { "type": "object", "title": "Pose to Image guidance", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Pose to Image guidance object — detects the pose of characters in the input image and uses it to guide generation" }, "title": "Pose to Image", "description": "Detects the pose of any characters in an input image, and will use this to guide your image generation.", "maxItems": 1 }, "depth": { "type": "array", "items": { "type": "object", "title": "Depth to Image guidance", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Depth to Image guidance — detects the depth features of the input image and uses them to guide generation" }, "title": "Depth to Image", "description": "Detects the depth features of any input image, and will use this to guide your image generation.", "maxItems": 1 }, "style": { "type": "array", "items": { "type": "object", "title": "Style reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH", "ULTRA", "MAX" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Style transfer guidance object, containing parameters available for style transfer image guidance" }, "title": "Style Reference", "description": "References the style from the input image to guide your image generation.", "maxItems": 4 }, "content": { "type": "array", "items": { "type": "object", "title": "Content reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH", "ULTRA" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Content transfer guidance object, containing parameters available for content transfer image guidance" }, "title": "Content Reference", "description": "References the form and content from the input image to guide your image generation.", "maxItems": 1 }, "character": { "type": "array", "items": { "type": "object", "title": "Character reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Character transfer guidance object, containing parameters available for character transfer image guidance" }, "title": "Content Reference", "description": "Generates an image in the likeness of the provided character reference image (works best with close up face portraits).", "maxItems": 1 }, "text_image": { "type": "array", "items": { "type": "object", "title": "Text Image Input guidance", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Text Image Input guidance — takes white text on a black background and uses it to guide image generation" }, "title": "Text Image Input", "description": "Takes in white text on a black background, and will use this to guide your image generation.", "maxItems": 1 }, "image_to_image": { "type": "array", "items": { "type": "object", "title": "Image to image", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the image to image guidance" } }, "description": "Image to image guidance object, containing parameters available for image to image guidance" }, "title": "Image to Image", "description": "Creative reinterpretation of vibe or structure from a reference image.", "maxItems": 1 } } }, "style_ids": { "type": "array", "items": { "enum": [ "703d6fe5-7f1c-4a9e-8da0-5331f214d5cf", "7d7c2bc5-4b12-4ac3-81a9-630057e9e89f", "1fbb6a68-9319-44d2-8d56-2957ca0ece6a", "2e74ec31-f3a4-4825-b08b-2894f6d13941", "556c1ee5-ec38-42e8-955a-1e82dad0ffa1", "785d778b-cdd3-4cf5-8ec1-d6e995254077", "ee13fe69-c387-4728-b274-de390a067200" ], "type": "string", "format": "uuid" }, "title": "Style IDs for Image Models", "default": [ "703d6fe5-7f1c-4a9e-8da0-5331f214d5cf" ], "description": "An array of style UUIDs for image models (limited to 1 style)." }, "transparency": { "type": "boolean", "title": "Transparency", "description": "Whether the image can be generated with a transparent background", "default": false }, "user_elements": { "type": "array", "items": { "properties": { "weight": { "minimum": 0 } } }, "title": "Your Elements", "default": [], "description": "An array of User Elements for image generation.", "maxItems": 4 }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "OFF", "description": "Whether to enhance the prompt or not" }, "negative_prompt": { "type": "string", "title": "Negative Prompt", "maxLength": 1000, "description": "The negative prompt to use for the generation" }, "platform_elements": { "type": "array", "items": { "properties": { "weight": { "minimum": 0 } } }, "title": "Platform Elements", "default": [], "description": "An array of Platform Elements for image generation.", "maxItems": 4 } } } }, "example": { "model": "graphic-design", "parameters": { "mode": "FAST", "width": 1024, "height": 1024, "prompt": "your prompt here", "quantity": 4, "style_ids": [ "703d6fe5-7f1c-4a9e-8da0-5331f214d5cf" ], "transparency": false, "prompt_enhance": "OFF" } } }, "LightningXlGenerationRequest": { "title": "Leonardo Lightning", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "lightning-xl" ], "description": "Must be `lightning-xl`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt" ], "properties": { "mode": { "type": "string", "title": "Generation Mode", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Use this instead of `quality` for all proprietary models!", "enum": [ "FAST", "QUALITY" ], "anyOf": [ { "enum": [ "FAST" ] }, { "enum": [ "QUALITY" ] } ], "default": "FAST" }, "seed": { "type": "integer", "title": "Seed", "description": "The seed value for generation", "minimum": 0 }, "width": { "type": "integer", "title": "Width", "maximum": 1584, "minimum": 32, "description": "The width of the image to generate in pixels", "default": 1024, "multipleOf": 8 }, "height": { "type": "integer", "title": "Height", "maximum": 1536, "minimum": 32, "description": "The height of the image to generate in pixels", "default": 1024, "multipleOf": 8 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "tiling": { "type": "boolean", "title": "Tiling" }, "contrast": { "enum": [ "LOW", "MEDIUM", "HIGH" ], "type": "string", "title": "Contrast", "default": "MEDIUM", "description": "The contrast the image should have" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 4, "maximum": 8 }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "properties": { "edge": { "type": "array", "items": { "type": "object", "title": "Edge to Image guidance", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Edge to Image guidance object — detects edges in the input image and uses them to guide generation" }, "title": "Edge to Image", "description": "Detects edges of any input image, and will use this to guide your image generation.", "maxItems": 1 }, "pose": { "type": "array", "items": { "type": "object", "title": "Pose to Image guidance", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Pose to Image guidance object — detects the pose of characters in the input image and uses it to guide generation" }, "title": "Pose to Image", "description": "Detects the pose of any characters in an input image, and will use this to guide your image generation.", "maxItems": 1 }, "depth": { "type": "array", "items": { "type": "object", "title": "Depth to Image guidance", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Depth to Image guidance — detects the depth features of the input image and uses them to guide generation" }, "title": "Depth to Image", "description": "Detects the depth features of any input image, and will use this to guide your image generation.", "maxItems": 1 }, "style": { "type": "array", "items": { "type": "object", "title": "Style reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH", "ULTRA", "MAX" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Style transfer guidance object, containing parameters available for style transfer image guidance" }, "title": "Style Reference", "description": "References the style from the input image to guide your image generation.", "maxItems": 4 }, "content": { "type": "array", "items": { "type": "object", "title": "Content reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH", "ULTRA" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Content transfer guidance object, containing parameters available for content transfer image guidance" }, "title": "Content Reference", "description": "References the form and content from the input image to guide your image generation.", "maxItems": 1 }, "character": { "type": "array", "items": { "type": "object", "title": "Character reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Character transfer guidance object, containing parameters available for character transfer image guidance" }, "title": "Content Reference", "description": "Generates an image in the likeness of the provided character reference image (works best with close up face portraits).", "maxItems": 1 }, "text_image": { "type": "array", "items": { "type": "object", "title": "Text Image Input guidance", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Text Image Input guidance — takes white text on a black background and uses it to guide image generation" }, "title": "Text Image Input", "description": "Takes in white text on a black background, and will use this to guide your image generation.", "maxItems": 1 }, "image_to_image": { "type": "array", "items": { "type": "object", "title": "Image to image", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "strength": { "enum": [ "LOW", "MID", "HIGH" ], "type": "string", "default": "MID", "description": "The strength of the image to image guidance" } }, "description": "Image to image guidance object, containing parameters available for image to image guidance" }, "title": "Image to Image", "description": "Creative reinterpretation of vibe or structure from a reference image.", "maxItems": 1 } } }, "style_ids": { "type": "array", "items": { "enum": [ "a5632c7c-ddbb-4e2f-ba34-8456ab3ac436", "dee282d3-891f-4f73-ba02-7f8131e5541b", "645e4195-f63d-4715-a3f2-3fb1e6eb8c70", "6fedbf1f-4a17-45ec-84fb-92fe524a29ef", "594c4a08-a522-4e0e-b7ff-e4dac4b6b622", "5bdc3f2a-1be6-4d1c-8e77-992a30824a2c", "ab5a4220-7c42-41e5-a578-eddb9fed3d75", "debdf72a-91a4-467b-bf61-cc02bdeb69c6", "b504f83c-3326-4947-82e1-7fe9e839ec0f", "62736842-6e4b-4028-b79a-4f1a1606e893", "6105baa2-851b-446e-9db5-08a671a8c42f", "0d914779-c822-430a-b976-30075033f1c4", "a2f7ea66-959b-4bbe-b508-6133238b76b6", "621e1c9a-6319-4bee-a12d-ae40659162fa", "cadc8cd6-7838-4c99-b645-df76be8ba8d8", "d574325d-1278-4fe2-974b-768525f253c3", "85da2dcc-c373-464c-9a7a-5624359be859", "9fdc5e8c-4d13-49b4-9ce6-5a74cbb19177", "be8c6b58-739c-4d44-b9c1-b032ed308b61", "093accc3-7633-4ffd-82da-d34000dfc0d6", "111dc692-d470-4eec-b791-3475abac4c46", "556c1ee5-ec38-42e8-955a-1e82dad0ffa1" ], "type": "string", "format": "uuid" }, "title": "Style IDs for Image Models", "default": [ "111dc692-d470-4eec-b791-3475abac4c46" ], "description": "An array of style UUIDs for image models (limited to 1 style)." }, "transparency": { "type": "boolean", "title": "Transparency", "description": "Whether the image can be generated with a transparent background", "default": false }, "user_elements": { "type": "array", "items": { "properties": { "weight": { "minimum": 0 } } }, "title": "Your Elements", "default": [], "description": "An array of User Elements for image generation.", "maxItems": 4 }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "OFF", "description": "Whether to enhance the prompt or not" }, "negative_prompt": { "type": "string", "title": "Negative Prompt", "maxLength": 1000, "description": "The negative prompt to use for the generation" }, "platform_elements": { "type": "array", "items": { "properties": { "weight": { "minimum": 0 } } }, "title": "Platform Elements", "default": [], "description": "An array of Platform Elements for image generation.", "maxItems": 4 } } } }, "example": { "model": "lightning-xl", "parameters": { "mode": "FAST", "width": 1024, "height": 1024, "prompt": "your prompt here", "contrast": "MEDIUM", "quantity": 4, "style_ids": [ "111dc692-d470-4eec-b791-3475abac4c46" ], "transparency": false, "prompt_enhance": "OFF" } } }, "IdeogramV3_0GenerationRequest": { "title": "Ideogram 3.0", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "ideogram-v3.0" ], "description": "Must be `ideogram-v3.0`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt" ], "properties": { "seed": { "type": "integer", "title": "Seed", "description": "The seed value for generation", "maximum": 2147483647, "minimum": 0 }, "width": { "type": "integer", "title": "Width", "maximum": 2048, "minimum": 32, "description": "The width of the image to generate in pixels", "default": 1024 }, "height": { "type": "integer", "title": "Height", "maximum": 2048, "minimum": 32, "description": "The height of the image to generate in pixels", "default": 1024 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "quality": { "type": "string", "title": "Quality", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Use this instead of `mode` for all third-party models!", "enum": [ "TURBO", "BALANCED", "QUALITY" ], "anyOf": [ { "enum": [ "TURBO" ] }, { "enum": [ "BALANCED" ] }, { "enum": [ "QUALITY" ] } ] }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 4, "maximum": 8 }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis." }, "style_ids": { "type": "array", "items": { "enum": [ "a5632c7c-ddbb-4e2f-ba34-8456ab3ac436", "6fedbf1f-4a17-45ec-84fb-92fe524a29ef", "111dc692-d470-4eec-b791-3475abac4c46", "594c4a08-a522-4e0e-b7ff-e4dac4b6b622", "ab5a4220-7c42-41e5-a578-eddb9fed3d75", "5bdc3f2a-1be6-4d1c-8e77-992a30824a2c", "dee282d3-891f-4f73-ba02-7f8131e5541b", "556c1ee5-ec38-42e8-955a-1e82dad0ffa1" ], "type": "string", "format": "uuid" }, "title": "Style IDs for Image Models", "default": [ "111dc692-d470-4eec-b791-3475abac4c46" ], "description": "An array of style UUIDs for image models (limited to 1 style)." }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" }, "negative_prompt": { "type": "string", "title": "Negative Prompt", "maxLength": 1000, "description": "The negative prompt to use for the generation" } }, "description": "Ideogram 3.0 Model Parameters" } }, "example": { "model": "ideogram-v3.0", "parameters": { "width": 1024, "height": 1024, "prompt": "your prompt here", "quantity": 4, "style_ids": [ "111dc692-d470-4eec-b791-3475abac4c46" ] } } }, "IdeogramV4_0GenerationRequest": { "title": "Ideogram 4.0", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "ideogram-v4.0" ], "description": "Must be `ideogram-v4.0`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ {} ], "required": [ "prompt" ], "properties": { "width": { "enum": [ 1152, 1248, 1280, 1296, 1440, 1600, 1664, 1728, 1792, 2048, 2240, 2304, 2496, 2560, 2880, 2944, 3072, 3168, 3328 ], "type": "integer", "description": "If you send `width`, also send `height`. The two must form one of the supported width × height pairs: 2048×2048, 1440×2880, 2880×1440, 1664×2496, 2496×1664, 1792×2240, 2240×1792, 1440×2560, 2560×1440, 1600×2560, 2560×1600, 1728×2304, 2304×1728, 1296×3168, 3168×1296, 1152×2944, 2944×1152, 1248×3328, 3328×1248, 1280×3072, 3072×1280." }, "height": { "enum": [ 1152, 1248, 1280, 1296, 1440, 1600, 1664, 1728, 1792, 2048, 2240, 2304, 2496, 2560, 2880, 2944, 3072, 3168, 3328 ], "type": "integer", "description": "If you send `height`, also send `width`. The two must form one of the supported width × height pairs: 2048×2048, 1440×2880, 2880×1440, 1664×2496, 2496×1664, 1792×2240, 2240×1792, 1440×2560, 2560×1440, 1600×2560, 2560×1600, 1728×2304, 2304×1728, 1296×3168, 3168×1296, 1152×2944, 2944×1152, 1248×3328, 3328×1248, 1280×3072, 3072×1280." }, "prompt": { "type": "string", "maxLength": 10000, "minLength": 1 }, "quality": { "type": "string", "title": "Quality", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Use this instead of `mode` for all third-party models!", "enum": [ "TURBO", "BALANCED", "QUALITY" ], "anyOf": [ { "enum": [ "TURBO" ] }, { "enum": [ "BALANCED" ] }, { "enum": [ "QUALITY" ] } ], "default": "BALANCED" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 4, "maximum": 4 }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" } }, "description": "Ideogram 4.0 Model Parameters" } }, "example": { "model": "ideogram-v4.0", "parameters": { "prompt": "your prompt here", "quality": "BALANCED", "quantity": 4 } } }, "Ideogram_pImageIdeogramGenerationRequest": { "title": "P-Image-Ideogram", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "ideogram/p-image-ideogram" ], "description": "Must be `ideogram/p-image-ideogram`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ {}, {}, {}, {}, {}, {}, {} ], "required": [ "prompt" ], "properties": { "width": { "enum": [ 512, 640, 720, 800, 832, 864, 896, 1024, 1120, 1152, 1248, 1280, 1440, 1536, 1600, 1664, 1728, 1792, 2048, 2240, 2304, 2496, 2560, 2880, 3072, 3456 ], "type": "integer", "default": 1024, "description": "If you send `width`, also send `height`. The two must form one of the supported width × height pairs: 1024×1024, 2048×2048, 1280×720, 2560×1440, 720×1280, 1440×2560, 1152×864, 2304×1728, 864×1152, 1728×2304, 1248×832, 2496×1664, 832×1248, 1664×2496, 1280×800, 2560×1600, 800×1280, 1600×2560, 1536×512, 3456×1024, 512×1536, 1024×3456, 896×1120, 1792×2240, 1440×720, 2880×1440, 1536×640, 3072×1280." }, "height": { "enum": [ 512, 640, 720, 800, 832, 864, 896, 1024, 1120, 1152, 1248, 1280, 1440, 1536, 1600, 1664, 1728, 1792, 2048, 2240, 2304, 2496, 2560, 2880, 3072, 3456 ], "type": "integer", "default": 1024, "description": "If you send `height`, also send `width`. The two must form one of the supported width × height pairs: 1024×1024, 2048×2048, 1280×720, 2560×1440, 720×1280, 1440×2560, 1152×864, 2304×1728, 864×1152, 1728×2304, 1248×832, 2496×1664, 832×1248, 1664×2496, 1280×800, 2560×1600, 800×1280, 1600×2560, 1536×512, 3456×1024, 512×1536, 1024×3456, 896×1120, 1792×2240, 1440×720, 2880×1440, 1536×640, 3072×1280." }, "prompt": { "type": "string", "maxLength": 10000, "minLength": 1 }, "quality": { "type": "string", "title": "Quality", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Use this instead of `mode` for all third-party models!", "enum": [ "VERY_LOW", "LOW", "MEDIUM", "HIGH" ], "anyOf": [ { "enum": [ "VERY_LOW" ] }, { "enum": [ "LOW" ] }, { "enum": [ "MEDIUM" ] }, { "enum": [ "HIGH" ] } ], "default": "MEDIUM" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 4, "maximum": 8 }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" } }, "description": "P-Image-Ideogram Model Parameters" } }, "example": { "model": "ideogram/p-image-ideogram", "parameters": { "width": 1024, "height": 1024, "prompt": "your prompt here", "quality": "MEDIUM", "quantity": 4 } } }, "Ideogram_ideogram4_5GenerationRequest": { "title": "Ideogram 4.5", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "ideogram/ideogram-4.5" ], "description": "Must be `ideogram/ideogram-4.5`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ {}, {}, {} ], "required": [ "prompt" ], "properties": { "seed": { "type": "integer", "title": "Seed", "description": "The seed value for generation", "maximum": 2147483647, "minimum": 0 }, "width": { "enum": [ 720, 800, 832, 864, 896, 1024, 1120, 1152, 1248, 1280, 1296, 1440, 1600, 1664, 1728, 1792, 2048, 2240, 2304, 2496, 2560, 2880, 2944, 3072, 3168, 3328 ], "type": "integer", "default": 1024, "description": "If you send `width`, also send `height`. The two must form one of the supported width × height pairs: 2048×2048, 1440×2880, 2880×1440, 1664×2496, 2496×1664, 1792×2240, 2240×1792, 1440×2560, 2560×1440, 1600×2560, 2560×1600, 1728×2304, 2304×1728, 1296×3168, 3168×1296, 1152×2944, 2944×1152, 1248×3328, 3328×1248, 1280×3072, 3072×1280, 1024×1024, 896×1120, 1120×896, 864×1152, 1152×864, 832×1248, 1248×832, 800×1280, 1280×800, 720×1280, 1280×720, 720×1440, 1440×720." }, "height": { "enum": [ 720, 800, 832, 864, 896, 1024, 1120, 1152, 1248, 1280, 1296, 1440, 1600, 1664, 1728, 1792, 2048, 2240, 2304, 2496, 2560, 2880, 2944, 3072, 3168, 3328 ], "type": "integer", "default": 1024, "description": "If you send `height`, also send `width`. The two must form one of the supported width × height pairs: 2048×2048, 1440×2880, 2880×1440, 1664×2496, 2496×1664, 1792×2240, 2240×1792, 1440×2560, 2560×1440, 1600×2560, 2560×1600, 1728×2304, 2304×1728, 1296×3168, 3168×1296, 1152×2944, 2944×1152, 1248×3328, 3328×1248, 1280×3072, 3072×1280, 1024×1024, 896×1120, 1120×896, 864×1152, 1152×864, 832×1248, 1248×832, 800×1280, 1280×800, 720×1280, 1280×720, 720×1440, 1440×720." }, "prompt": { "type": "string", "maxLength": 10000, "minLength": 1 }, "quality": { "type": "string", "title": "Quality", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Use this instead of `mode` for all third-party models!", "enum": [ "VERY_LOW", "LOW", "MEDIUM", "HIGH" ], "anyOf": [ { "enum": [ "VERY_LOW" ] }, { "enum": [ "LOW" ] }, { "enum": [ "MEDIUM" ] }, { "enum": [ "HIGH" ] } ], "default": "MEDIUM" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 4, "maximum": 8 }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "properties": { "image_reference": { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" } }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 5 } } }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" } }, "description": "Ideogram 4.5 model parameters" } }, "example": { "model": "ideogram/ideogram-4.5", "parameters": { "width": 1024, "height": 1024, "prompt": "your prompt here", "quality": "MEDIUM", "quantity": 4 } } }, "Gemini2_5FlashImageGenerationRequest": { "title": "Nano Banana", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "gemini-2.5-flash-image" ], "description": "Must be `gemini-2.5-flash-image`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ { "anyOf": [ { "not": { "anyOf": [ { "required": [ "width" ] }, { "required": [ "height" ] } ] } }, { "type": "object", "required": [ "width" ], "properties": { "width": { "enum": [ 0 ] } } }, { "type": "object", "required": [ "height" ], "properties": { "height": { "enum": [ 0 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1024 ] }, "height": { "enum": [ 1024 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 832 ] }, "height": { "enum": [ 1248 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1248 ] }, "height": { "enum": [ 832 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 864 ] }, "height": { "enum": [ 1184 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1184 ] }, "height": { "enum": [ 864 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 896 ] }, "height": { "enum": [ 1152 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1152 ] }, "height": { "enum": [ 896 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1344 ] }, "height": { "enum": [ 768 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 768 ] }, "height": { "enum": [ 1344 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1536 ] }, "height": { "enum": [ 672 ] } } } ] } ], "required": [ "prompt" ], "properties": { "seed": { "type": "integer", "title": "Seed", "description": "The seed value for generation", "maximum": 2147483638, "minimum": 0 }, "width": { "enum": [ 0, 768, 832, 864, 896, 1024, 1152, 1184, 1248, 1344, 1536 ], "type": "integer", "default": 1024 }, "height": { "enum": [ 0, 672, 768, 832, 864, 896, 1024, 1152, 1184, 1248, 1344 ], "type": "integer", "default": 1024 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 8 }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "properties": { "image_reference": { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" } }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 6 } } }, "style_ids": { "type": "array", "items": { "enum": [ "debdf72a-91a4-467b-bf61-cc02bdeb69c6", "3cbb655a-7ca4-463f-b697-8a03ad67327c", "6fedbf1f-4a17-45ec-84fb-92fe524a29ef", "111dc692-d470-4eec-b791-3475abac4c46", "594c4a08-a522-4e0e-b7ff-e4dac4b6b622", "09d2b5b5-d7c5-4c02-905d-9f84051640f4", "703d6fe5-7f1c-4a9e-8da0-5331f214d5cf", "7d7c2bc5-4b12-4ac3-81a9-630057e9e89f", "645e4195-f63d-4715-a3f2-3fb1e6eb8c70", "ab5a4220-7c42-41e5-a578-eddb9fed3d75", "4edb03c9-8a26-4041-9d01-f85b5d4abd71", "0d34f8e1-46d4-428f-8ddd-4b11811fa7c9", "22a9a7d2-2166-4d86-80ff-22e2643adbcf", "7c3f932b-a572-47cb-9b9b-f20211e63b5b", "581ba6d6-5aac-4492-bebe-54c424a0d46e", "b504f83c-3326-4947-82e1-7fe9e839ec0f", "5bdc3f2a-1be6-4d1c-8e77-992a30824a2c", "1db308ce-c7ad-4d10-96fd-592fa6b75cc4", "556c1ee5-ec38-42e8-955a-1e82dad0ffa1" ], "type": "string", "format": "uuid" }, "title": "Style IDs for Image Models", "default": [ "111dc692-d470-4eec-b791-3475abac4c46" ], "description": "An array of style UUIDs for image models (limited to 1 style)." }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" } }, "description": "Gemini 2.5 Flash Image Model Parameters" } }, "example": { "model": "gemini-2.5-flash-image", "parameters": { "width": 1024, "height": 1024, "prompt": "your prompt here", "quantity": 1, "style_ids": [ "111dc692-d470-4eec-b791-3475abac4c46" ] } } }, "NanoBanana2GenerationRequest": { "title": "Nano Banana 2", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "nano-banana-2" ], "description": "Must be `nano-banana-2`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ { "anyOf": [ { "not": { "anyOf": [ { "required": [ "width" ] }, { "required": [ "height" ] } ] } }, { "type": "object", "required": [ "width" ], "properties": { "width": { "enum": [ 0 ] } } }, { "type": "object", "required": [ "height" ], "properties": { "height": { "enum": [ 0 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 768 ] }, "height": { "enum": [ 768 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 848 ] }, "height": { "enum": [ 848 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 896 ] }, "height": { "enum": [ 896 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 928 ] }, "height": { "enum": [ 928 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1024 ] }, "height": { "enum": [ 1024 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1152 ] }, "height": { "enum": [ 1152 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1200 ] }, "height": { "enum": [ 1200 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1264 ] }, "height": { "enum": [ 1264 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1376 ] }, "height": { "enum": [ 1376 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1536 ] }, "height": { "enum": [ 1536 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1696 ] }, "height": { "enum": [ 1696 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1792 ] }, "height": { "enum": [ 1792 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1856 ] }, "height": { "enum": [ 1856 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 2048 ] }, "height": { "enum": [ 2048 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 2304 ] }, "height": { "enum": [ 2304 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 2400 ] }, "height": { "enum": [ 2400 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 2528 ] }, "height": { "enum": [ 2528 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 2752 ] }, "height": { "enum": [ 2752 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 3072 ] }, "height": { "enum": [ 3072 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 3392 ] }, "height": { "enum": [ 3392 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 3584 ] }, "height": { "enum": [ 3584 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 3712 ] }, "height": { "enum": [ 3712 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 4096 ] }, "height": { "enum": [ 4096 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 4608 ] }, "height": { "enum": [ 4608 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 4800 ] }, "height": { "enum": [ 4800 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 5056 ] }, "height": { "enum": [ 5056 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 5504 ] }, "height": { "enum": [ 5504 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 848 ] }, "height": { "enum": [ 1264 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1696 ] }, "height": { "enum": [ 2528 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 3392 ] }, "height": { "enum": [ 5056 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1264 ] }, "height": { "enum": [ 848 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 2528 ] }, "height": { "enum": [ 1696 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 5056 ] }, "height": { "enum": [ 3392 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 896 ] }, "height": { "enum": [ 1200 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1792 ] }, "height": { "enum": [ 2400 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 3584 ] }, "height": { "enum": [ 4800 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1200 ] }, "height": { "enum": [ 896 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 2400 ] }, "height": { "enum": [ 1792 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 4800 ] }, "height": { "enum": [ 3584 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 928 ] }, "height": { "enum": [ 1152 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1856 ] }, "height": { "enum": [ 2304 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 3712 ] }, "height": { "enum": [ 4608 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1152 ] }, "height": { "enum": [ 928 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 2304 ] }, "height": { "enum": [ 1856 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 4608 ] }, "height": { "enum": [ 3712 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 768 ] }, "height": { "enum": [ 1376 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1536 ] }, "height": { "enum": [ 2752 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 3072 ] }, "height": { "enum": [ 5504 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1376 ] }, "height": { "enum": [ 768 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 2752 ] }, "height": { "enum": [ 1536 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 5504 ] }, "height": { "enum": [ 3072 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1584 ] }, "height": { "enum": [ 672 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 3168 ] }, "height": { "enum": [ 1344 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 6336 ] }, "height": { "enum": [ 2688 ] } } } ] } ], "required": [ "prompt" ], "properties": { "seed": { "type": "integer", "title": "Seed", "description": "The seed value for generation", "maximum": 2147483638, "minimum": 0 }, "width": { "enum": [ 0, 768, 848, 896, 928, 1024, 1152, 1200, 1264, 1376, 1536, 1584, 1696, 1792, 1856, 2048, 2304, 2400, 2528, 2752, 3072, 3168, 3392, 3584, 3712, 4096, 4608, 4800, 5056, 5504, 6336 ], "type": "integer", "default": 1024 }, "height": { "enum": [ 0, 672, 768, 848, 896, 928, 1024, 1152, 1200, 1264, 1344, 1376, 1536, 1696, 1792, 1856, 2048, 2304, 2400, 2528, 2688, 2752, 3072, 3392, 3584, 3712, 4096, 4608, 4800, 5056, 5504 ], "type": "integer", "default": 1024 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 8 }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "properties": { "image_reference": { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" } }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 6 }, "video_reference_base": { "type": "array", "items": { "type": "object", "title": "Video Reference Base", "required": [ "video" ], "properties": { "video": { "type": "object", "title": "Video reference", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Video URL (enriched by backend when video is resolved" }, "type": { "enum": [ "UPLOADED", "GENERATED" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" }, "duration": { "type": "number" }, "motion_has_audio": { "type": "boolean" } }, "description": "A reference to a video", "additionalProperties": false } } }, "title": "Video Reference Base", "description": "Base video to be edited.", "maxItems": 1 } } }, "style_ids": { "type": "array", "items": { "enum": [ "debdf72a-91a4-467b-bf61-cc02bdeb69c6", "3cbb655a-7ca4-463f-b697-8a03ad67327c", "6fedbf1f-4a17-45ec-84fb-92fe524a29ef", "111dc692-d470-4eec-b791-3475abac4c46", "594c4a08-a522-4e0e-b7ff-e4dac4b6b622", "09d2b5b5-d7c5-4c02-905d-9f84051640f4", "703d6fe5-7f1c-4a9e-8da0-5331f214d5cf", "7d7c2bc5-4b12-4ac3-81a9-630057e9e89f", "645e4195-f63d-4715-a3f2-3fb1e6eb8c70", "ab5a4220-7c42-41e5-a578-eddb9fed3d75", "4edb03c9-8a26-4041-9d01-f85b5d4abd71", "0d34f8e1-46d4-428f-8ddd-4b11811fa7c9", "22a9a7d2-2166-4d86-80ff-22e2643adbcf", "7c3f932b-a572-47cb-9b9b-f20211e63b5b", "581ba6d6-5aac-4492-bebe-54c424a0d46e", "b504f83c-3326-4947-82e1-7fe9e839ec0f", "5bdc3f2a-1be6-4d1c-8e77-992a30824a2c", "1db308ce-c7ad-4d10-96fd-592fa6b75cc4", "556c1ee5-ec38-42e8-955a-1e82dad0ffa1" ], "type": "string", "format": "uuid" }, "title": "Style IDs for Image Models", "default": [ "111dc692-d470-4eec-b791-3475abac4c46" ], "description": "An array of style UUIDs for image models (limited to 1 style)." }, "annotation": { "type": "boolean", "title": "Annotation", "description": "Whether an image reference has marks drawn on it that show what to change" }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" } }, "description": "Nano Banana 2 Image Model Parameters" } }, "example": { "model": "nano-banana-2", "parameters": { "width": 1024, "height": 1024, "prompt": "your prompt here", "quantity": 1, "style_ids": [ "111dc692-d470-4eec-b791-3475abac4c46" ] } } }, "Google_nanoBanana2_1GenerationRequest": { "title": "Nano Banana 2.1", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "google/nano-banana-2.1" ], "description": "Must be `google/nano-banana-2.1`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ { "anyOf": [ { "not": { "anyOf": [ { "required": [ "width" ] }, { "required": [ "height" ] } ] } }, { "type": "object", "required": [ "width" ], "properties": { "width": { "enum": [ 0 ] } } }, { "type": "object", "required": [ "height" ], "properties": { "height": { "enum": [ 0 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 768 ] }, "height": { "enum": [ 768 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 848 ] }, "height": { "enum": [ 848 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 896 ] }, "height": { "enum": [ 896 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 928 ] }, "height": { "enum": [ 928 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1024 ] }, "height": { "enum": [ 1024 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1152 ] }, "height": { "enum": [ 1152 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1200 ] }, "height": { "enum": [ 1200 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1264 ] }, "height": { "enum": [ 1264 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1376 ] }, "height": { "enum": [ 1376 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1696 ] }, "height": { "enum": [ 1696 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1792 ] }, "height": { "enum": [ 1792 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1856 ] }, "height": { "enum": [ 1856 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 2048 ] }, "height": { "enum": [ 2048 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 2304 ] }, "height": { "enum": [ 2304 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 2400 ] }, "height": { "enum": [ 2400 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 2528 ] }, "height": { "enum": [ 2528 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 2752 ] }, "height": { "enum": [ 2752 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 3392 ] }, "height": { "enum": [ 3392 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 3584 ] }, "height": { "enum": [ 3584 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 3712 ] }, "height": { "enum": [ 3712 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 4096 ] }, "height": { "enum": [ 4096 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 4608 ] }, "height": { "enum": [ 4608 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 4800 ] }, "height": { "enum": [ 4800 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 5056 ] }, "height": { "enum": [ 5056 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 5504 ] }, "height": { "enum": [ 5504 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 848 ] }, "height": { "enum": [ 1264 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1696 ] }, "height": { "enum": [ 2528 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 3392 ] }, "height": { "enum": [ 5056 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1264 ] }, "height": { "enum": [ 848 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 2528 ] }, "height": { "enum": [ 1696 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 5056 ] }, "height": { "enum": [ 3392 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 896 ] }, "height": { "enum": [ 1200 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1792 ] }, "height": { "enum": [ 2400 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 3584 ] }, "height": { "enum": [ 4800 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1200 ] }, "height": { "enum": [ 896 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 2400 ] }, "height": { "enum": [ 1792 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 4800 ] }, "height": { "enum": [ 3584 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 928 ] }, "height": { "enum": [ 1152 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1856 ] }, "height": { "enum": [ 2304 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 3712 ] }, "height": { "enum": [ 4608 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1152 ] }, "height": { "enum": [ 928 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 2304 ] }, "height": { "enum": [ 1856 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 4608 ] }, "height": { "enum": [ 3712 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 768 ] }, "height": { "enum": [ 1376 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1536 ] }, "height": { "enum": [ 2752 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 3072 ] }, "height": { "enum": [ 5504 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1376 ] }, "height": { "enum": [ 768 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 2752 ] }, "height": { "enum": [ 1536 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 5504 ] }, "height": { "enum": [ 3072 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1584 ] }, "height": { "enum": [ 672 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 3168 ] }, "height": { "enum": [ 1344 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 6336 ] }, "height": { "enum": [ 2688 ] } } } ] } ], "required": [ "prompt" ], "properties": { "width": { "enum": [ 0, 768, 848, 896, 928, 1024, 1152, 1200, 1264, 1376, 1536, 1584, 1696, 1792, 1856, 2048, 2304, 2400, 2528, 2752, 3072, 3168, 3392, 3584, 3712, 4096, 4608, 4800, 5056, 5504, 6336 ], "type": "integer", "default": 1024 }, "height": { "enum": [ 0, 672, 768, 848, 896, 928, 1024, 1152, 1200, 1264, 1344, 1376, 1536, 1696, 1792, 1856, 2048, 2304, 2400, 2528, 2688, 2752, 3072, 3392, 3584, 3712, 4096, 4608, 4800, 5056, 5504 ], "type": "integer", "default": 1024 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 8 }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "properties": { "image_reference": { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" } }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 14 }, "video_reference_base": { "type": "array", "items": { "type": "object", "title": "Video Reference Base", "required": [ "video" ], "properties": { "video": { "type": "object", "title": "Video reference", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Video URL (enriched by backend when video is resolved" }, "type": { "enum": [ "UPLOADED", "GENERATED" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" }, "duration": { "type": "number" }, "motion_has_audio": { "type": "boolean" } }, "description": "A reference to a video", "additionalProperties": false } } }, "title": "Video Reference Base", "description": "Base video to be edited.", "maxItems": 1 } } }, "style_ids": { "type": "array", "items": { "enum": [ "debdf72a-91a4-467b-bf61-cc02bdeb69c6", "3cbb655a-7ca4-463f-b697-8a03ad67327c", "6fedbf1f-4a17-45ec-84fb-92fe524a29ef", "111dc692-d470-4eec-b791-3475abac4c46", "594c4a08-a522-4e0e-b7ff-e4dac4b6b622", "09d2b5b5-d7c5-4c02-905d-9f84051640f4", "703d6fe5-7f1c-4a9e-8da0-5331f214d5cf", "7d7c2bc5-4b12-4ac3-81a9-630057e9e89f", "645e4195-f63d-4715-a3f2-3fb1e6eb8c70", "ab5a4220-7c42-41e5-a578-eddb9fed3d75", "4edb03c9-8a26-4041-9d01-f85b5d4abd71", "0d34f8e1-46d4-428f-8ddd-4b11811fa7c9", "22a9a7d2-2166-4d86-80ff-22e2643adbcf", "7c3f932b-a572-47cb-9b9b-f20211e63b5b", "581ba6d6-5aac-4492-bebe-54c424a0d46e", "b504f83c-3326-4947-82e1-7fe9e839ec0f", "5bdc3f2a-1be6-4d1c-8e77-992a30824a2c", "1db308ce-c7ad-4d10-96fd-592fa6b75cc4", "556c1ee5-ec38-42e8-955a-1e82dad0ffa1" ], "type": "string", "format": "uuid" }, "title": "Style IDs for Image Models", "default": [ "111dc692-d470-4eec-b791-3475abac4c46" ], "description": "An array of style UUIDs for image models (limited to 1 style)." }, "annotation": { "type": "boolean", "title": "Annotation", "description": "Whether an image reference has marks drawn on it that show what to change" }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" } }, "description": "Nano Banana 2.1 Image Model Parameters" } }, "example": { "model": "google/nano-banana-2.1", "parameters": { "width": 1024, "height": 1024, "prompt": "your prompt here", "quantity": 1, "style_ids": [ "111dc692-d470-4eec-b791-3475abac4c46" ] } } }, "NanoBanana2LiteGenerationRequest": { "title": "Nano Banana 2 Lite", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "nano-banana-2-lite" ], "description": "Must be `nano-banana-2-lite`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt" ], "properties": { "seed": { "type": "integer", "title": "Seed", "description": "The seed value for generation", "maximum": 2147483638, "minimum": 0 }, "width": { "enum": [ 0, 768, 848, 896, 928, 1024, 1152, 1200, 1264, 1376, 1584 ], "type": "integer", "default": 1024 }, "height": { "enum": [ 0, 672, 768, 848, 896, 928, 1024, 1152, 1200, 1264, 1376 ], "type": "integer", "default": 1024 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 8 }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "properties": { "image_reference": { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" } }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 6 } } }, "style_ids": { "type": "array", "items": { "enum": [ "debdf72a-91a4-467b-bf61-cc02bdeb69c6", "3cbb655a-7ca4-463f-b697-8a03ad67327c", "6fedbf1f-4a17-45ec-84fb-92fe524a29ef", "111dc692-d470-4eec-b791-3475abac4c46", "594c4a08-a522-4e0e-b7ff-e4dac4b6b622", "09d2b5b5-d7c5-4c02-905d-9f84051640f4", "703d6fe5-7f1c-4a9e-8da0-5331f214d5cf", "7d7c2bc5-4b12-4ac3-81a9-630057e9e89f", "645e4195-f63d-4715-a3f2-3fb1e6eb8c70", "ab5a4220-7c42-41e5-a578-eddb9fed3d75", "4edb03c9-8a26-4041-9d01-f85b5d4abd71", "0d34f8e1-46d4-428f-8ddd-4b11811fa7c9", "22a9a7d2-2166-4d86-80ff-22e2643adbcf", "7c3f932b-a572-47cb-9b9b-f20211e63b5b", "581ba6d6-5aac-4492-bebe-54c424a0d46e", "b504f83c-3326-4947-82e1-7fe9e839ec0f", "5bdc3f2a-1be6-4d1c-8e77-992a30824a2c", "1db308ce-c7ad-4d10-96fd-592fa6b75cc4", "556c1ee5-ec38-42e8-955a-1e82dad0ffa1" ], "type": "string", "format": "uuid" }, "title": "Style IDs for Image Models", "default": [ "111dc692-d470-4eec-b791-3475abac4c46" ], "description": "An array of style UUIDs for image models (limited to 1 style)." }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" } }, "description": "Nano Banana 2 Image Model Parameters" } }, "example": { "model": "nano-banana-2-lite", "parameters": { "width": 1024, "height": 1024, "prompt": "your prompt here", "quantity": 1, "style_ids": [ "111dc692-d470-4eec-b791-3475abac4c46" ] } } }, "GeminiImage2GenerationRequest": { "title": "Nano Banana Pro", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "gemini-image-2" ], "description": "Must be `gemini-image-2`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt" ], "properties": { "seed": { "type": "integer", "title": "Seed", "description": "The seed value for generation", "maximum": 2147483638, "minimum": 0 }, "width": { "enum": [ 0, 768, 848, 896, 928, 1024, 1152, 1200, 1264, 1376, 1536, 1584, 1696, 1792, 1856, 2048, 2304, 2400, 2528, 2752, 3072, 3168, 3392, 3584, 3712, 4096, 4608, 4800, 5056, 5504, 6336 ], "type": "integer", "default": 1024 }, "height": { "enum": [ 0, 672, 768, 848, 896, 928, 1024, 1152, 1200, 1264, 1344, 1376, 1536, 1696, 1792, 1856, 2048, 2304, 2400, 2528, 2688, 2752, 3072, 3392, 3584, 3712, 4096, 4608, 4800, 5056, 5504 ], "type": "integer", "default": 1024 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 8 }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "properties": { "image_reference": { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" } }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 14 } } }, "style_ids": { "type": "array", "items": { "enum": [ "debdf72a-91a4-467b-bf61-cc02bdeb69c6", "3cbb655a-7ca4-463f-b697-8a03ad67327c", "6fedbf1f-4a17-45ec-84fb-92fe524a29ef", "111dc692-d470-4eec-b791-3475abac4c46", "594c4a08-a522-4e0e-b7ff-e4dac4b6b622", "09d2b5b5-d7c5-4c02-905d-9f84051640f4", "703d6fe5-7f1c-4a9e-8da0-5331f214d5cf", "7d7c2bc5-4b12-4ac3-81a9-630057e9e89f", "645e4195-f63d-4715-a3f2-3fb1e6eb8c70", "ab5a4220-7c42-41e5-a578-eddb9fed3d75", "4edb03c9-8a26-4041-9d01-f85b5d4abd71", "0d34f8e1-46d4-428f-8ddd-4b11811fa7c9", "22a9a7d2-2166-4d86-80ff-22e2643adbcf", "7c3f932b-a572-47cb-9b9b-f20211e63b5b", "581ba6d6-5aac-4492-bebe-54c424a0d46e", "b504f83c-3326-4947-82e1-7fe9e839ec0f", "5bdc3f2a-1be6-4d1c-8e77-992a30824a2c", "1db308ce-c7ad-4d10-96fd-592fa6b75cc4", "556c1ee5-ec38-42e8-955a-1e82dad0ffa1" ], "type": "string", "format": "uuid" }, "title": "Style IDs for Image Models", "default": [ "111dc692-d470-4eec-b791-3475abac4c46" ], "description": "An array of style UUIDs for image models (limited to 1 style)." }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" } }, "description": "Nano Banana Pro Model Parameters" } }, "example": { "model": "gemini-image-2", "parameters": { "width": 1024, "height": 1024, "prompt": "your prompt here", "quantity": 1, "style_ids": [ "111dc692-d470-4eec-b791-3475abac4c46" ] } } }, "Kling2_5GenerationRequest": { "title": "Kling 2.5 Turbo", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "kling-2.5" ], "description": "Must be `kling-2.5`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ { "anyOf": [ { "type": "object", "properties": { "width": { "enum": [ 1280 ] }, "height": { "enum": [ 720 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 960 ] }, "height": { "enum": [ 960 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 720 ] }, "height": { "enum": [ 1280 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1920 ] }, "height": { "enum": [ 1080 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1440 ] }, "height": { "enum": [ 1440 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1080 ] }, "height": { "enum": [ 1920 ] } } } ] }, {}, {} ], "required": [ "prompt" ], "properties": { "mode": { "type": "string", "title": "Quality", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Deprecated. Width and height are the canonical inputs for this model. This field is retained for backwards compatibility with mobile clients and Production API consumers that still send `mode`. Validation is silent: omitted is the new norm; explicit values are still consistency-checked against width and height.", "enum": [ "RESOLUTION_720", "RESOLUTION_1080" ], "anyOf": [ { "enum": [ "RESOLUTION_720" ] }, { "enum": [ "RESOLUTION_1080" ] } ], "default": "RESOLUTION_1080", "deprecated": true }, "width": { "type": "integer", "title": "Width", "maximum": 9007199254740991, "minimum": 0, "description": "The width of the image to generate in pixels", "default": 1920 }, "height": { "type": "integer", "title": "Height", "maximum": 9007199254740991, "minimum": 0, "description": "The height of the image to generate in pixels", "default": 1080 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 2500, "minLength": 1, "description": "The prompt to use for the generation" }, "duration": { "type": "integer", "title": "Duration", "description": "Duration of the video in seconds", "enum": [ 5, 10 ], "default": 5 }, "quantity": { "type": "number", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 1 }, "guidances": { "type": "object", "properties": { "end_frame": { "type": "array", "items": { "type": "object", "title": "End Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "End Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 }, "start_frame": { "type": "array", "items": { "type": "object", "title": "Start Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "Start Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 } } }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" } }, "description": "Architecture properties of the Kling 2.5 model" } }, "example": { "model": "kling-2.5", "parameters": { "width": 1920, "height": 1080, "prompt": "your prompt here", "duration": 5 } } }, "Kling2_6GenerationRequest": { "title": "Kling 2.6", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "kling-2.6" ], "description": "Must be `kling-2.6`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ { "anyOf": [ { "type": "object", "properties": { "width": { "enum": [ 0 ] }, "height": { "enum": [ 0 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1920 ] }, "height": { "enum": [ 1080 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1440 ] }, "height": { "enum": [ 1440 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1080 ] }, "height": { "enum": [ 1920 ] } } } ] } ], "oneOf": [ { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1920 ] }, "height": { "enum": [ 1080 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1080 ] }, "height": { "enum": [ 1920 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1440 ] }, "height": { "enum": [ 1440 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 0 ] }, "height": { "enum": [ 0 ] } } }, { "not": { "anyOf": [ { "required": [ "width" ] }, { "required": [ "height" ] } ] } } ], "required": [ "prompt" ], "properties": { "mode": { "type": "string", "title": "Quality", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Deprecated. Width and height are the canonical inputs for this model. This field is retained for backwards compatibility with mobile clients and Production API consumers that still send `mode`. Validation is silent: omitted is the new norm; explicit values are still consistency-checked against width and height.", "enum": [ "RESOLUTION_1080" ], "default": "RESOLUTION_1080", "deprecated": true }, "audio": { "type": "boolean", "title": "Audio", "default": true, "description": "Whether the video generation will include audio.", "deprecated": true }, "width": { "enum": [ 1920, 1080, 1440, 0 ], "type": "integer" }, "height": { "enum": [ 1080, 1920, 1440, 0 ], "type": "integer" }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 2500, "minLength": 1, "description": "The prompt to use for the generation" }, "duration": { "type": "integer", "title": "Duration", "description": "Duration of the video in seconds", "enum": [ 5, 10 ], "default": 5 }, "quantity": { "type": "number", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 1 }, "guidances": { "type": "object", "properties": { "start_frame": { "type": "array", "items": { "type": "object", "title": "Start Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "Start Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 } } }, "start_frame": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Video start frame", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "The start frame init_image to start a generation with", "deprecated": true }, "motion_has_audio": { "type": "boolean", "title": "Audio", "default": true, "description": "Whether the video generation will include audio." } }, "description": "Architecture properties of the Kling 2.6 model" } }, "example": { "model": "kling-2.6", "parameters": { "prompt": "your prompt here", "duration": 5 } } }, "Kling2_5TurboStandardGenerationRequest": { "title": "Kling 2.5 Turbo Standard", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "kling-2.5-turbo-standard" ], "description": "Must be `kling-2.5-turbo-standard`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ { "not": { "allOf": [ { "required": [ "start_frame" ] }, { "required": [ "guidances" ], "properties": { "guidances": { "type": "object", "required": [ "start_frame" ], "properties": { "start_frame": { "type": "array", "minItems": 1 } } } } } ] } }, { "anyOf": [ { "type": "object", "properties": { "width": { "enum": [ 1280 ] }, "height": { "enum": [ 720 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 960 ] }, "height": { "enum": [ 960 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 720 ] }, "height": { "enum": [ 1280 ] } } } ] } ], "required": [ "prompt", "guidances" ], "properties": { "mode": { "type": "string", "title": "Quality", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Deprecated. Width and height are the canonical inputs for this model. This field is retained for backwards compatibility with mobile clients and Production API consumers that still send `mode`. Validation is silent: omitted is the new norm; explicit values are still consistency-checked against width and height.", "enum": [ "RESOLUTION_720" ], "default": "RESOLUTION_720", "deprecated": true }, "width": { "type": "integer", "title": "Width", "maximum": 9007199254740991, "minimum": 0, "description": "The width of the image to generate in pixels", "default": 1280 }, "height": { "type": "integer", "title": "Height", "maximum": 9007199254740991, "minimum": 0, "description": "The height of the image to generate in pixels", "default": 720 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 2500, "minLength": 1, "description": "The prompt to use for the generation" }, "duration": { "type": "integer", "title": "Duration", "description": "Duration of the video in seconds", "enum": [ 5, 10 ], "default": 5 }, "quantity": { "type": "number", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 1 }, "guidances": { "type": "object", "required": [ "start_frame" ], "properties": { "start_frame": { "type": "array", "items": { "type": "object", "title": "Start Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "Start Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1, "minItems": 1 } } }, "start_frame": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Video start frame", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "The start frame init_image to start a generation with", "deprecated": true }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" } }, "description": "Architecture properties of the Kling 2.5 Turbo Standard model" } }, "example": { "model": "kling-2.5-turbo-standard", "parameters": { "width": 1280, "height": 720, "prompt": "your prompt here", "duration": 5, "guidances": "your guidances here" } } }, "LucidOriginGenerationRequest": { "title": "Lucid Origin", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "lucid-origin" ], "description": "Must be `lucid-origin`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt" ], "properties": { "mode": { "type": "string", "title": "Generation Mode", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Use this instead of `quality` for all proprietary models!", "enum": [ "FAST", "ULTRA" ], "oneOf": [ { "enum": [ "FAST" ] }, { "enum": [ "ULTRA" ] } ], "default": "FAST" }, "seed": { "type": "integer", "title": "Seed", "description": "The seed value for generation", "maximum": 2147483647, "minimum": 0 }, "width": { "type": "integer", "title": "Width", "maximum": 3840, "minimum": 16, "description": "The width of the image to generate in pixels", "default": 1200, "multipleOf": 8 }, "height": { "type": "integer", "title": "Height", "maximum": 3616, "minimum": 16, "description": "The height of the image to generate in pixels", "default": 1200, "multipleOf": 8 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 2000, "minLength": 1, "description": "The prompt to use for the generation" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 4, "maximum": 8 }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "properties": { "style": { "type": "array", "items": { "type": "object", "title": "Style reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH", "ULTRA", "MAX" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Style transfer guidance object, containing parameters available for style transfer image guidance" }, "title": "Style Reference", "description": "References the style from the input image to guide your image generation.", "maxItems": 1 }, "content": { "type": "array", "items": { "type": "object", "title": "Content reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH", "ULTRA" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Content transfer guidance object, containing parameters available for content transfer image guidance" }, "title": "Content Reference", "description": "References the form and content from the input image to guide your image generation.", "maxItems": 1 } } }, "style_ids": { "type": "array", "items": { "enum": [ "a5632c7c-ddbb-4e2f-ba34-8456ab3ac436", "6fedbf1f-4a17-45ec-84fb-92fe524a29ef", "111dc692-d470-4eec-b791-3475abac4c46", "594c4a08-a522-4e0e-b7ff-e4dac4b6b622", "ab5a4220-7c42-41e5-a578-eddb9fed3d75", "5bdc3f2a-1be6-4d1c-8e77-992a30824a2c", "dee282d3-891f-4f73-ba02-7f8131e5541b", "556c1ee5-ec38-42e8-955a-1e82dad0ffa1" ], "type": "string", "format": "uuid" }, "title": "Style IDs for Image Models", "default": [ "111dc692-d470-4eec-b791-3475abac4c46" ], "description": "An array of style UUIDs for image models (limited to 1 style)." }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" } }, "description": "Lucid Origin Model Parameters" } }, "example": { "model": "lucid-origin", "parameters": { "mode": "FAST", "width": 1200, "height": 1200, "prompt": "your prompt here", "quantity": 4, "style_ids": [ "111dc692-d470-4eec-b791-3475abac4c46" ] } } }, "LucidRealismGenerationRequest": { "title": "Lucid Realism", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "lucid-realism" ], "description": "Must be `lucid-realism`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt" ], "properties": { "mode": { "type": "string", "title": "Generation Mode", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Use this instead of `quality` for all proprietary models!", "enum": [ "FAST", "ULTRA" ], "oneOf": [ { "enum": [ "FAST" ] }, { "enum": [ "ULTRA" ] } ], "default": "FAST" }, "seed": { "type": "integer", "title": "Seed", "description": "The seed value for generation", "maximum": 2147483647, "minimum": 0 }, "width": { "type": "integer", "title": "Width", "maximum": 2496, "minimum": 16, "description": "The width of the image to generate in pixels", "default": 1024, "multipleOf": 8 }, "height": { "type": "integer", "title": "Height", "maximum": 2496, "minimum": 16, "description": "The height of the image to generate in pixels", "default": 1024, "multipleOf": 8 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 4, "maximum": 8 }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "properties": { "style": { "type": "array", "items": { "type": "object", "title": "Style reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH", "ULTRA", "MAX" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Style transfer guidance object, containing parameters available for style transfer image guidance" }, "title": "Style Reference", "description": "References the style from the input image to guide your image generation.", "maxItems": 1 }, "content": { "type": "array", "items": { "type": "object", "title": "Content reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH", "ULTRA" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Content transfer guidance object, containing parameters available for content transfer image guidance" }, "title": "Content Reference", "description": "References the form and content from the input image to guide your image generation.", "maxItems": 1 } } }, "style_ids": { "type": "array", "items": { "enum": [ "9fdc5e8c-4d13-49b4-9ce6-5a74cbb19177", "a5632c7c-ddbb-4e2f-ba34-8456ab3ac436", "cc53f935-884c-40a0-b7eb-1f5c42821fb5", "6fedbf1f-4a17-45ec-84fb-92fe524a29ef", "111dc692-d470-4eec-b791-3475abac4c46", "594c4a08-a522-4e0e-b7ff-e4dac4b6b622", "85da2dcc-c373-464c-9a7a-5624359be859", "d574325d-1278-4fe2-974b-768525f253c3", "97c20e5c-1af6-4d42-b227-54d03d8f0727", "335e6010-a75c-45d9-afc5-032c65e9180e", "30c1d34f-e3a9-479a-b56f-c018bbc9c02a", "cadc8cd6-7838-4c99-b645-df76be8ba8d8", "a2f7ea66-959b-4bbe-b508-6133238b76b6", "621e1c9a-6319-4bee-a12d-ae40659162fa", "0d914779-c822-430a-b976-30075033f1c4", "ab5a4220-7c42-41e5-a578-eddb9fed3d75", "6105baa2-851b-446e-9db5-08a671a8c42f", "5bdc3f2a-1be6-4d1c-8e77-992a30824a2c", "62736842-6e4b-4028-b79a-4f1a1606e893", "dee282d3-891f-4f73-ba02-7f8131e5541b", "556c1ee5-ec38-42e8-955a-1e82dad0ffa1" ], "type": "string", "format": "uuid" }, "title": "Style IDs for Image Models", "default": [ "111dc692-d470-4eec-b791-3475abac4c46" ], "description": "An array of style UUIDs for image models (limited to 1 style)." }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" } }, "description": "Lucid Realism Model Parameters" } }, "example": { "model": "lucid-realism", "parameters": { "mode": "FAST", "width": 1024, "height": 1024, "prompt": "your prompt here", "quantity": 4, "style_ids": [ "111dc692-d470-4eec-b791-3475abac4c46" ] } } }, "Ltxv2_3ProGenerationRequest": { "title": "LTX-2.3 Pro", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "ltxv-2.3-pro" ], "description": "Must be `ltxv-2.3-pro`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ {}, {} ], "required": [ "prompt", "quantity", "width", "height" ], "properties": { "mode": { "type": "string", "title": "Quality", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Deprecated. Width and height are the canonical inputs for this model. This field is retained for backwards compatibility with mobile clients and Production API consumers that still send `mode`. Validation is silent: omitted is the new norm; explicit values are still consistency-checked against width and height.", "enum": [ "RESOLUTION_1080", "RESOLUTION_1440", "RESOLUTION_2160" ], "anyOf": [ { "enum": [ "RESOLUTION_1080" ] }, { "enum": [ "RESOLUTION_1440" ] }, { "enum": [ "RESOLUTION_2160" ] } ], "default": "RESOLUTION_1080", "deprecated": true }, "width": { "type": "integer", "title": "Width", "maximum": 9007199254740991, "minimum": 0, "description": "The width of the image to generate in pixels", "default": 1920 }, "height": { "type": "integer", "title": "Height", "maximum": 9007199254740991, "minimum": 0, "description": "The height of the image to generate in pixels", "default": 1080 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 5000, "minLength": 1, "description": "The prompt to use for the generation" }, "duration": { "type": "integer", "title": "Duration", "description": "Duration of the video in seconds", "enum": [ 6, 8, 10 ], "default": 6 }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 1 }, "guidances": { "type": "object", "properties": { "end_frame": { "type": "array", "items": { "type": "object", "title": "End Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "End Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 }, "start_frame": { "type": "array", "items": { "type": "object", "title": "Start Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "Start Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 } } }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" }, "motion_has_audio": { "type": "boolean", "title": "Audio", "default": true, "description": "Whether the video generation will include audio." } }, "description": "Architecture properties of the LTX 2.3 Pro models" } }, "example": { "model": "ltxv-2.3-pro", "parameters": { "width": 1920, "height": 1080, "prompt": "your prompt here", "duration": 6, "quantity": 1 } } }, "Ltxv2_3FastGenerationRequest": { "title": "LTX-2.3 Fast", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "ltxv-2.3-fast" ], "description": "Must be `ltxv-2.3-fast`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ {}, {} ], "required": [ "prompt", "quantity", "width", "height" ], "properties": { "mode": { "type": "string", "title": "Quality", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Deprecated. Width and height are the canonical inputs for this model. This field is retained for backwards compatibility with mobile clients and Production API consumers that still send `mode`. Validation is silent: omitted is the new norm; explicit values are still consistency-checked against width and height.", "enum": [ "RESOLUTION_1080", "RESOLUTION_1440", "RESOLUTION_2160" ], "anyOf": [ { "enum": [ "RESOLUTION_1080" ] }, { "enum": [ "RESOLUTION_1440" ] }, { "enum": [ "RESOLUTION_2160" ] } ], "default": "RESOLUTION_1080", "deprecated": true }, "width": { "type": "integer", "title": "Width", "maximum": 9007199254740991, "minimum": 0, "description": "The width of the image to generate in pixels", "default": 1920 }, "height": { "type": "integer", "title": "Height", "maximum": 9007199254740991, "minimum": 0, "description": "The height of the image to generate in pixels", "default": 1080 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 5000, "minLength": 1, "description": "The prompt to use for the generation" }, "duration": { "type": "integer", "title": "Duration", "description": "Duration of the video in seconds", "enum": [ 6, 8, 10, 12, 14, 16, 18, 20 ], "default": 6 }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 1 }, "guidances": { "type": "object", "properties": { "end_frame": { "type": "array", "items": { "type": "object", "title": "End Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "End Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 }, "start_frame": { "type": "array", "items": { "type": "object", "title": "Start Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "Start Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 } } }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" }, "motion_has_audio": { "type": "boolean", "title": "Audio", "default": true, "description": "Whether the video generation will include audio." } }, "description": "Architecture properties of the LTX 2.3 Fast models" } }, "example": { "model": "ltxv-2.3-fast", "parameters": { "width": 1920, "height": 1080, "prompt": "your prompt here", "duration": 6, "quantity": 1 } } }, "HappyHorseGenerationRequest": { "title": "Happy Horse 1.0", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "happy-horse" ], "description": "Must be `happy-horse`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ {}, { "anyOf": [ { "type": "object", "properties": { "width": { "enum": [ 1280 ] }, "height": { "enum": [ 720 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 720 ] }, "height": { "enum": [ 1280 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 720 ] }, "height": { "enum": [ 720 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 960 ] }, "height": { "enum": [ 720 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 720 ] }, "height": { "enum": [ 960 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1920 ] }, "height": { "enum": [ 1080 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1080 ] }, "height": { "enum": [ 1920 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1080 ] }, "height": { "enum": [ 1080 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1440 ] }, "height": { "enum": [ 1080 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1080 ] }, "height": { "enum": [ 1440 ] } } } ] }, {} ], "required": [ "prompt", "quantity" ], "properties": { "mode": { "type": "string", "title": "Quality", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Deprecated. Width and height are the canonical inputs for this model. This field is retained for backwards compatibility with mobile clients and Production API consumers that still send `mode`. Validation is silent: omitted is the new norm; explicit values are still consistency-checked against width and height.", "enum": [ "RESOLUTION_720", "RESOLUTION_1080" ], "oneOf": [ { "enum": [ "RESOLUTION_720" ] }, { "enum": [ "RESOLUTION_1080" ] } ], "default": "RESOLUTION_1080", "deprecated": true }, "seed": { "type": "integer", "title": "Seed", "description": "The seed value for generation" }, "width": { "type": "integer", "default": 1920 }, "height": { "type": "integer", "default": 1080 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 2500, "minLength": 1, "description": "The prompt to use for the generation" }, "duration": { "type": "integer", "title": "Duration", "description": "Duration of the video in seconds", "enum": [ 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ], "default": 5 }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 1 }, "guidances": { "type": "object", "properties": { "start_frame": { "type": "array", "items": { "type": "object", "title": "Start Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "Start Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 }, "image_reference": { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" } }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 9 }, "video_reference_base": { "type": "array", "allOf": [ { "type": "array", "items": { "type": "object", "title": "Video Reference Base", "required": [ "video" ], "properties": { "video": { "type": "object", "title": "Video reference", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Video URL (enriched by backend when video is resolved" }, "type": { "enum": [ "UPLOADED", "GENERATED" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" }, "duration": { "type": "number" }, "motion_has_audio": { "type": "boolean" } }, "description": "A reference to a video", "additionalProperties": false } } }, "title": "Video Reference Base", "description": "Base video to be edited." }, { "items": { "type": "object", "properties": { "video": { "type": "object", "properties": { "width": { "type": "integer", "maximum": 2160, "minimum": 320 }, "height": { "type": "integer", "maximum": 2160, "minimum": 320 }, "duration": { "type": "number", "maximum": 15, "minimum": 3 } } } } } } ], "maxItems": 1, "properties": { "0": { "type": "object", "properties": { "video": { "type": "object", "properties": { "duration": {} } } } } } } }, "additionalProperties": false }, "audio_setting": { "enum": [ "auto", "origin" ], "type": "string", "default": "auto" }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" } }, "description": "Architecture properties of the Happy Horse model" } }, "example": { "model": "happy-horse", "parameters": { "width": 1920, "height": 1080, "prompt": "your prompt here", "duration": 5, "quantity": 1, "audio_setting": "auto" } } }, "HappyHorse1_1GenerationRequest": { "title": "Happy Horse 1.1", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "happy-horse-1.1" ], "description": "Must be `happy-horse-1.1`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ { "oneOf": [ { "properties": { "width": { "enum": [ 1280 ] }, "height": { "enum": [ 720 ] } } }, { "properties": { "width": { "enum": [ 720 ] }, "height": { "enum": [ 1280 ] } } }, { "properties": { "width": { "enum": [ 960 ] }, "height": { "enum": [ 960 ] } } }, { "properties": { "width": { "enum": [ 1108 ] }, "height": { "enum": [ 832 ] } } }, { "properties": { "width": { "enum": [ 832 ] }, "height": { "enum": [ 1108 ] } } }, { "properties": { "width": { "enum": [ 1920 ] }, "height": { "enum": [ 1080 ] } } }, { "properties": { "width": { "enum": [ 1080 ] }, "height": { "enum": [ 1920 ] } } }, { "properties": { "width": { "enum": [ 1440 ] }, "height": { "enum": [ 1440 ] } } }, { "properties": { "width": { "enum": [ 1662 ] }, "height": { "enum": [ 1248 ] } } }, { "properties": { "width": { "enum": [ 1248 ] }, "height": { "enum": [ 1662 ] } } } ] }, {} ], "required": [ "prompt", "quantity" ], "properties": { "seed": { "type": "integer", "title": "Seed", "description": "The seed value for generation" }, "width": { "type": "integer", "default": 1920, "description": "If you send `width`, also send `height`. The two must form one of the supported width × height pairs: 1280×720, 720×1280, 960×960, 1108×832, 832×1108, 1920×1080, 1080×1920, 1440×1440, 1662×1248, 1248×1662." }, "height": { "type": "integer", "default": 1080, "description": "If you send `height`, also send `width`. The two must form one of the supported width × height pairs: 1280×720, 720×1280, 960×960, 1108×832, 832×1108, 1920×1080, 1080×1920, 1440×1440, 1662×1248, 1248×1662." }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 2500, "minLength": 1, "description": "The prompt to use for the generation" }, "duration": { "type": "integer", "title": "Duration", "description": "Duration of the video in seconds", "enum": [ 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ], "default": 5 }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 1 }, "guidances": { "type": "object", "properties": { "start_frame": { "type": "array", "items": { "type": "object", "title": "Start Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "Start Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 }, "image_reference": { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" } }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 9 } }, "additionalProperties": false }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" }, "motion_has_audio": { "type": "boolean", "title": "Audio", "default": true, "description": "Whether the video generation will include audio." } }, "description": "Architecture properties of the Happy Horse 1.1 model" } }, "example": { "model": "happy-horse-1.1", "parameters": { "width": 1920, "height": 1080, "prompt": "your prompt here", "duration": 5, "quantity": 1 } } }, "Hailuo23GenerationRequest": { "title": "Hailuo 2.3", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "hailuo-2_3" ], "description": "Must be `hailuo-2_3`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ {}, {}, { "anyOf": [ { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1376 ] }, "height": { "enum": [ 768 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 768 ] }, "height": { "enum": [ 1376 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 768 ] }, "height": { "enum": [ 768 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1920 ] }, "height": { "enum": [ 1080 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1080 ] }, "height": { "enum": [ 1920 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1080 ] }, "height": { "enum": [ 1080 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 0 ] }, "height": { "enum": [ 0 ] } } } ] }, {}, {}, {} ], "required": [ "prompt", "quantity", "width", "height" ], "properties": { "mode": { "type": "string", "title": "Quality", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Deprecated. Width and height are the canonical inputs for this model. This field is retained for backwards compatibility with mobile clients and Production API consumers that still send `mode`. Validation is silent: omitted is the new norm; explicit values are still consistency-checked against width and height.", "enum": [ "RESOLUTION_768", "RESOLUTION_1080" ], "anyOf": [ { "enum": [ "RESOLUTION_768" ] }, { "enum": [ "RESOLUTION_1080" ] } ], "default": "RESOLUTION_768", "deprecated": true }, "width": { "enum": [ 768, 1376, 1080, 1920, 0 ], "type": "integer", "default": 1376 }, "height": { "enum": [ 768, 1376, 1080, 1920, 0 ], "type": "integer", "default": 768 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 3000, "minLength": 1, "description": "The prompt to use for the generation" }, "duration": { "type": "integer", "title": "Duration", "description": "Duration of the video in seconds", "enum": [ 6, 10 ], "oneOf": [ { "enum": [ 6 ] }, { "enum": [ 10 ] } ], "default": 6 }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 1 }, "guidances": { "type": "object", "properties": { "start_frame": { "type": "array", "items": { "type": "object", "title": "Start Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "Start Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 } }, "additionalProperties": false }, "style_ids": { "type": "array", "items": { "enum": [ "964d8a8f-865b-48c5-b79e-e75ae8727648", "9cdfea2a-b4ab-4e97-a558-ec9fcb78f30a", "12b0d8c9-5cf8-4094-a3e5-6809bc269e21", "c4ac9781-8624-4b7d-bbed-dedaaf7b9da6", "28a53b2e-eb80-41d7-8360-208068fecf49", "d28c8f2b-22bb-4c0c-893d-d3835e28f2f7", "6078b232-d1be-4a01-9c10-95c05132a8e4", "d760b628-4a1d-41cb-bccb-053a13973b94", "c39fe4f8-76d6-4aad-899b-e7ca5a4148f3", "7d36972e-b9d5-46c7-813d-2c9934f9321b", "ff9bfd01-a7ac-4556-889a-25dd5fc0956f", "be32c760-2bb3-49ae-83dc-6f9b2d62a97f", "1d6e92d2-6e83-4ea2-bd4c-34ddfedfa163", "3f705252-1197-4f59-b6ed-21625dce6a65", "64b84d56-8b76-4367-95a6-df345a909af0", "4b60b356-a4ab-4983-9e9a-30e0d5b27bc6", "771bc1bd-0f88-4ff9-af63-f646847ed075", "1974bd47-75bb-499a-9c7a-354913904fcf", "994e33e6-4862-495d-9efb-d9a09ecdd769", "acb9deb3-31e3-495e-ab31-b138fde26bd6", "fa347beb-6d70-482d-94a8-a70736e9e7f1", "746e70e5-ab4d-4f39-9057-75698cb64bc2", "92c2d8d4-9757-4cbf-88f3-d7ea54c425af", "21b0a3e9-304a-4ff2-9603-15ddbc5a6b82", "dcfb60ca-f165-407f-b01c-2b34d22432c2", "913efd9b-1da8-4876-91d3-b6de0aa5582c", "9581d460-7023-4d85-b440-9fea8bbfe194", "9517dd8e-9588-4fe5-aede-6711438dd420", "d26aded5-e191-45d5-9662-db36b7085a76", "2380bd07-caf1-4ae6-a348-3bcf4b12f90a", "6c27f994-2e03-4d07-95b8-4a5db5bd3a27", "1bffb3f3-4110-4185-85f9-f7254ae6f81d", "46af026e-d21a-4cf4-a0c0-b482e6800331", "9243b709-ed08-49d9-9198-440f2127d3b5", "f84bbf31-1d72-415d-ae4c-deb4b18fccba", "d838fb14-9719-44f3-877e-da70d072b79c", "556c1ee5-ec38-42e8-955a-1e82dad0ffa1" ], "type": "string", "format": "uuid" }, "title": "Style IDs for Video Models", "default": [], "description": "An array of zero or more style UUIDs for video models (vibe, lighting, color)." } } } }, "example": { "model": "hailuo-2_3", "parameters": { "width": 1376, "height": 768, "prompt": "your prompt here", "duration": 6, "quantity": 1 } } }, "Hailuo23FastGenerationRequest": { "title": "Hailuo 2.3 Fast", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "hailuo-2_3-fast" ], "description": "Must be `hailuo-2_3-fast`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ {}, {}, { "anyOf": [ { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1376 ] }, "height": { "enum": [ 768 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 768 ] }, "height": { "enum": [ 1376 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 768 ] }, "height": { "enum": [ 768 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1920 ] }, "height": { "enum": [ 1080 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1080 ] }, "height": { "enum": [ 1920 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1080 ] }, "height": { "enum": [ 1080 ] } } }, { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "enum": [ 0 ] }, "height": { "enum": [ 0 ] } } } ] }, {}, {}, {} ], "required": [ "prompt", "quantity", "guidances" ], "properties": { "mode": { "type": "string", "title": "Quality", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Deprecated. Width and height are the canonical inputs for this model. This field is retained for backwards compatibility with mobile clients and Production API consumers that still send `mode`. Validation is silent: omitted is the new norm; explicit values are still consistency-checked against width and height.", "enum": [ "RESOLUTION_768", "RESOLUTION_1080" ], "anyOf": [ { "enum": [ "RESOLUTION_768" ] }, { "enum": [ "RESOLUTION_1080" ] } ], "default": "RESOLUTION_768", "deprecated": true }, "width": { "enum": [ 768, 1376, 1080, 1920, 0 ], "type": "integer", "default": 1376 }, "height": { "enum": [ 768, 1376, 1080, 1920, 0 ], "type": "integer", "default": 768 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 3000, "minLength": 1, "description": "The prompt to use for the generation" }, "duration": { "type": "integer", "title": "Duration", "description": "Duration of the video in seconds", "enum": [ 6, 10 ], "oneOf": [ { "enum": [ 6 ] }, { "enum": [ 10 ] } ], "default": 6 }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 1 }, "guidances": { "type": "object", "required": [ "start_frame" ], "properties": { "end_frame": { "type": "array", "items": { "type": "object", "title": "End Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "End Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 0 }, "start_frame": { "type": "array", "items": { "type": "object", "title": "Start Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "Start Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1, "minItems": 1 } }, "additionalProperties": false }, "style_ids": { "type": "array", "items": { "enum": [ "964d8a8f-865b-48c5-b79e-e75ae8727648", "9cdfea2a-b4ab-4e97-a558-ec9fcb78f30a", "12b0d8c9-5cf8-4094-a3e5-6809bc269e21", "c4ac9781-8624-4b7d-bbed-dedaaf7b9da6", "28a53b2e-eb80-41d7-8360-208068fecf49", "d28c8f2b-22bb-4c0c-893d-d3835e28f2f7", "6078b232-d1be-4a01-9c10-95c05132a8e4", "d760b628-4a1d-41cb-bccb-053a13973b94", "c39fe4f8-76d6-4aad-899b-e7ca5a4148f3", "7d36972e-b9d5-46c7-813d-2c9934f9321b", "ff9bfd01-a7ac-4556-889a-25dd5fc0956f", "be32c760-2bb3-49ae-83dc-6f9b2d62a97f", "1d6e92d2-6e83-4ea2-bd4c-34ddfedfa163", "3f705252-1197-4f59-b6ed-21625dce6a65", "64b84d56-8b76-4367-95a6-df345a909af0", "4b60b356-a4ab-4983-9e9a-30e0d5b27bc6", "771bc1bd-0f88-4ff9-af63-f646847ed075", "1974bd47-75bb-499a-9c7a-354913904fcf", "994e33e6-4862-495d-9efb-d9a09ecdd769", "acb9deb3-31e3-495e-ab31-b138fde26bd6", "fa347beb-6d70-482d-94a8-a70736e9e7f1", "746e70e5-ab4d-4f39-9057-75698cb64bc2", "92c2d8d4-9757-4cbf-88f3-d7ea54c425af", "21b0a3e9-304a-4ff2-9603-15ddbc5a6b82", "dcfb60ca-f165-407f-b01c-2b34d22432c2", "913efd9b-1da8-4876-91d3-b6de0aa5582c", "9581d460-7023-4d85-b440-9fea8bbfe194", "9517dd8e-9588-4fe5-aede-6711438dd420", "d26aded5-e191-45d5-9662-db36b7085a76", "2380bd07-caf1-4ae6-a348-3bcf4b12f90a", "6c27f994-2e03-4d07-95b8-4a5db5bd3a27", "1bffb3f3-4110-4185-85f9-f7254ae6f81d", "46af026e-d21a-4cf4-a0c0-b482e6800331", "9243b709-ed08-49d9-9198-440f2127d3b5", "f84bbf31-1d72-415d-ae4c-deb4b18fccba", "d838fb14-9719-44f3-877e-da70d072b79c", "556c1ee5-ec38-42e8-955a-1e82dad0ffa1" ], "type": "string", "format": "uuid" }, "title": "Style IDs for Video Models", "default": [], "description": "An array of zero or more style UUIDs for video models (vibe, lighting, color)." } } } }, "example": { "model": "hailuo-2_3-fast", "parameters": { "width": 1376, "height": 768, "prompt": "your prompt here", "duration": 6, "quantity": 1, "guidances": "your guidances here" } } }, "Hailuo03GenerationRequest": { "title": "MiniMax H3", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "hailuo-03" ], "description": "Must be `hailuo-03`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ { "anyOf": [ { "type": "object", "properties": { "width": { "enum": [ 1120 ] }, "height": { "enum": [ 480 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 856 ] }, "height": { "enum": [ 480 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 640 ] }, "height": { "enum": [ 480 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 480 ] }, "height": { "enum": [ 480 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 480 ] }, "height": { "enum": [ 640 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 480 ] }, "height": { "enum": [ 856 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1792 ] }, "height": { "enum": [ 768 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1376 ] }, "height": { "enum": [ 768 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1024 ] }, "height": { "enum": [ 768 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 768 ] }, "height": { "enum": [ 768 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 768 ] }, "height": { "enum": [ 1024 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 768 ] }, "height": { "enum": [ 1376 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 3360 ] }, "height": { "enum": [ 1440 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 2560 ] }, "height": { "enum": [ 1440 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1920 ] }, "height": { "enum": [ 1440 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1440 ] }, "height": { "enum": [ 1440 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1440 ] }, "height": { "enum": [ 1920 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1440 ] }, "height": { "enum": [ 2560 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 5040 ] }, "height": { "enum": [ 2160 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 3840 ] }, "height": { "enum": [ 2160 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 2880 ] }, "height": { "enum": [ 2160 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 2160 ] }, "height": { "enum": [ 2160 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 2160 ] }, "height": { "enum": [ 2880 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 2160 ] }, "height": { "enum": [ 3840 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 0 ] }, "height": { "enum": [ 0 ] } } } ] }, {}, {}, {}, {}, {}, {}, {}, {}, {} ], "required": [ "prompt", "quantity" ], "properties": { "width": { "enum": [ 0, 480, 640, 768, 856, 1024, 1120, 1376, 1440, 1792, 1920, 2160, 2560, 2880, 3360, 3840, 5040 ], "type": "integer", "default": 1376 }, "height": { "enum": [ 0, 480, 640, 768, 856, 1024, 1376, 1440, 1920, 2160, 2560, 2880, 3840 ], "type": "integer", "default": 768 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 7000, "minLength": 1, "description": "The prompt to use for the generation" }, "quality": { "type": "string", "title": "Quality", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Use this instead of `mode` for all third-party models!", "enum": [ "STANDARD", "ACCELERATED", "TURBO" ], "anyOf": [ { "enum": [ "STANDARD" ] }, { "enum": [ "ACCELERATED" ] }, { "enum": [ "TURBO" ] } ], "default": "TURBO" }, "duration": { "type": "integer", "title": "Duration", "description": "Duration of the video in seconds", "enum": [ 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ], "default": 6 }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 1 }, "guidances": { "type": "object", "properties": { "end_frame": { "type": "array", "items": { "type": "object", "title": "End Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "End Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 }, "start_frame": { "type": "array", "items": { "type": "object", "title": "Start Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "Start Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 }, "audio_reference": { "type": "array", "allOf": [ { "type": "array", "items": { "type": "object", "title": "Audio reference", "required": [ "audio" ], "properties": { "audio": { "type": "object", "title": "Audio reference", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Audio URL (enriched by backend when audio is resolved)" }, "type": { "enum": [ "UPLOADED", "GENERATED" ], "type": "string" }, "duration": { "type": "number" } }, "description": "A reference to audio", "additionalProperties": false } } }, "title": "Audio Reference", "description": "Specifies a list of audio references for guidance" } ], "maxItems": 3, "description": "Audio clips used as generation references. Requires an image reference or a video reference; a start or end frame does not count. Not available at quality TURBO." }, "image_reference": { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" } }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 9 }, "video_reference_base": { "type": "array", "allOf": [ { "type": "array", "items": { "type": "object", "title": "Video Reference Base", "required": [ "video" ], "properties": { "video": { "type": "object", "title": "Video reference", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Video URL (enriched by backend when video is resolved" }, "type": { "enum": [ "UPLOADED", "GENERATED" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" }, "duration": { "type": "number" }, "motion_has_audio": { "type": "boolean" } }, "description": "A reference to a video", "additionalProperties": false } } }, "title": "Video Reference Base", "description": "Base video to be edited." }, { "items": { "type": "object", "properties": { "video": { "type": "object", "required": [ "duration" ] } } } } ], "maxItems": 3 } }, "additionalProperties": false }, "resolution": { "enum": [ "480p", "768p", "2k", "4k" ], "type": "string", "default": "768p", "description": "Output resolution used when width and height are 0 (automatic). Explicit width and height take precedence." }, "motion_has_audio": { "type": "boolean", "title": "Audio", "default": true, "description": "MiniMax H3 always generates native audio; this cannot be disabled." } } } }, "example": { "model": "hailuo-03", "parameters": { "width": 1376, "height": 768, "prompt": "your prompt here", "quality": "TURBO", "duration": 6, "quantity": 1, "resolution": "768p" } } }, "Alibaba_wan3_0GenerationRequest": { "title": "Wan 3.0", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "alibaba/wan-3.0" ], "description": "Must be `alibaba/wan-3.0`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ { "anyOf": [ { "type": "object", "properties": { "width": { "enum": [ 854 ] }, "height": { "enum": [ 480 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 736 ] }, "height": { "enum": [ 552 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 640 ] }, "height": { "enum": [ 640 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 552 ] }, "height": { "enum": [ 736 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 480 ] }, "height": { "enum": [ 854 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1280 ] }, "height": { "enum": [ 720 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1104 ] }, "height": { "enum": [ 828 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 960 ] }, "height": { "enum": [ 960 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 828 ] }, "height": { "enum": [ 1104 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 720 ] }, "height": { "enum": [ 1280 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1920 ] }, "height": { "enum": [ 1080 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1656 ] }, "height": { "enum": [ 1242 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1440 ] }, "height": { "enum": [ 1440 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1242 ] }, "height": { "enum": [ 1656 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1080 ] }, "height": { "enum": [ 1920 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 0 ] }, "height": { "enum": [ 0 ] } } } ] }, {} ], "required": [ "prompt" ], "properties": { "seed": { "type": "integer", "title": "Seed", "description": "The seed value for generation", "maximum": 2147483647, "minimum": 0 }, "width": { "type": "integer", "title": "Width", "maximum": 9007199254740991, "minimum": 0, "description": "The width of the image to generate in pixels", "enum": [ 854, 736, 640, 552, 480, 1280, 1104, 960, 828, 720, 1920, 1656, 1440, 1242, 1080, 0 ] }, "height": { "type": "integer", "title": "Height", "maximum": 9007199254740991, "minimum": 0, "description": "The height of the image to generate in pixels", "enum": [ 480, 552, 640, 736, 854, 720, 828, 960, 1104, 1280, 1080, 1242, 1440, 1656, 1920, 0 ] }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 5000, "minLength": 1, "description": "The prompt to use for the generation" }, "quality": { "type": "string", "title": "Quality", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Use this instead of `mode` for all third-party models!", "enum": [ "STANDARD", "ACCELERATED" ], "anyOf": [ { "enum": [ "STANDARD" ] }, { "enum": [ "ACCELERATED" ] } ], "default": "ACCELERATED" }, "duration": { "type": "integer", "title": "Duration", "description": "Duration of the video in seconds", "enum": [ 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30 ], "default": 5 }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 1 }, "guidances": { "type": "object", "properties": { "end_frame": { "type": "array", "items": { "type": "object", "title": "End Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "End Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 }, "start_frame": { "type": "array", "items": { "type": "object", "title": "Start Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "Start Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 }, "audio_reference": { "type": "array", "allOf": [ { "type": "array", "items": { "type": "object", "title": "Audio reference", "required": [ "audio" ], "properties": { "audio": { "type": "object", "title": "Audio reference", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Audio URL (enriched by backend when audio is resolved)" }, "type": { "enum": [ "UPLOADED", "GENERATED" ], "type": "string" }, "duration": { "type": "number" } }, "description": "A reference to audio", "additionalProperties": false } } }, "title": "Audio Reference", "description": "Specifies a list of audio references for guidance" } ], "maxItems": 5, "description": "Audio clips used as generation references. Valid on their own or alongside image or video references. Cannot be combined with a start or end frame." }, "image_reference": { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" } }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 10 }, "webpage_reference": { "type": "array", "items": { "type": "object", "title": "Webpage reference", "required": [ "webpage" ], "properties": { "webpage": { "type": "object", "title": "URL reference", "properties": { "url": { "type": "string", "title": "URL", "format": "uri", "description": "URL which must be publically accessible to download the image media from" } }, "description": "A reference to some URL" } } }, "title": "Webpage Reference", "maxItems": 1, "description": "A public webpage URL whose content guides the generation." }, "video_reference_base": { "type": "array", "allOf": [ { "type": "array", "items": { "type": "object", "title": "Video Reference Base", "required": [ "video" ], "properties": { "video": { "type": "object", "title": "Video reference", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Video URL (enriched by backend when video is resolved" }, "type": { "enum": [ "UPLOADED", "GENERATED" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" }, "duration": { "type": "number" }, "motion_has_audio": { "type": "boolean" } }, "description": "A reference to a video", "additionalProperties": false } } }, "title": "Video Reference Base", "description": "Base video to be edited." } ], "maxItems": 5 } }, "additionalProperties": false }, "resolution": { "enum": [ "480p", "720p", "1080p" ], "type": "string", "default": "480p", "description": "Output resolution tier, used when width and height are automatic (0). Explicit dimensions take precedence." }, "motion_has_audio": { "type": "boolean", "title": "Audio", "default": true, "description": "Whether the video generation will include audio." } } } }, "example": { "model": "alibaba/wan-3.0", "parameters": { "prompt": "your prompt here", "quality": "ACCELERATED", "duration": 5, "resolution": "480p", "motion_has_audio": true } } }, "Wan2_7GenerationRequest": { "title": "Wan 2.7", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "wan-2.7" ], "description": "Must be `wan-2.7`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ {}, { "anyOf": [ { "type": "object", "properties": { "width": { "enum": [ 1280 ] }, "height": { "enum": [ 720 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 720 ] }, "height": { "enum": [ 1280 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 960 ] }, "height": { "enum": [ 960 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1920 ] }, "height": { "enum": [ 1080 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1080 ] }, "height": { "enum": [ 1920 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1440 ] }, "height": { "enum": [ 1440 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 0 ] }, "height": { "enum": [ 0 ] } } } ] }, {} ], "required": [ "prompt" ], "properties": { "width": { "type": "integer", "title": "Width", "maximum": 9007199254740991, "minimum": 0, "description": "The width of the image to generate in pixels", "enum": [ 1280, 720, 960, 1920, 1080, 1440, 0 ] }, "height": { "type": "integer", "title": "Height", "maximum": 9007199254740991, "minimum": 0, "description": "The height of the image to generate in pixels", "enum": [ 720, 1280, 960, 1920, 1080, 1440, 0 ] }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 2500, "minLength": 1, "description": "The prompt to use for the generation" }, "duration": { "type": "integer", "title": "Duration", "description": "Duration of the video in seconds", "enum": [ 2, 3, 4, 5, 6, 7, 8, 9, 10 ], "default": 5 }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 1 }, "guidances": { "type": "object", "properties": { "end_frame": { "type": "array", "items": { "type": "object", "title": "End Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "End Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 }, "start_frame": { "type": "array", "items": { "type": "object", "title": "Start Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "Start Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 }, "image_reference": { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" } }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 6 }, "video_reference_base": { "type": "array", "allOf": [ { "type": "array", "items": { "type": "object", "title": "Video Reference Base", "required": [ "video" ], "properties": { "video": { "type": "object", "title": "Video reference", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Video URL (enriched by backend when video is resolved" }, "type": { "enum": [ "UPLOADED", "GENERATED" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" }, "duration": { "type": "number" }, "motion_has_audio": { "type": "boolean" } }, "description": "A reference to a video", "additionalProperties": false } } }, "title": "Video Reference Base", "description": "Base video to be edited." }, { "items": { "type": "object", "properties": { "type": { "enum": [ "BASE", "FEATURE" ], "type": "string", "description": "BASE routes to edit-video; FEATURE routes to reference-to-video. No schema default on purpose: when omitted, the transform derives it from omni_edit (true -> BASE, false/absent -> FEATURE)." }, "video": { "type": "object", "required": [ "duration" ], "properties": { "width": { "type": "integer", "maximum": 2160, "minimum": 720 }, "height": { "type": "integer", "maximum": 2160, "minimum": 720 }, "duration": { "type": "number", "maximum": 10.05, "minimum": 2 } } } } } } ], "maxItems": 1 } }, "additionalProperties": false }, "omni_edit": { "type": "boolean", "description": "Sent by the omni edit surface (true) and the generate screen (false). When a video_reference_base item omits type, omni_edit=true derives BASE (edit-video); false/absent derives FEATURE (reference-to-video)." }, "resolution": { "enum": [ "720p", "1080p" ], "type": "string", "default": "720p", "description": "Output resolution for edit mode. Determines cost tier and is forwarded to the provider." } } } }, "example": { "model": "wan-2.7", "parameters": { "prompt": "your prompt here", "duration": 5, "resolution": "720p" } } }, "Bfl_flux3VideoGenerationRequest": { "title": "FLUX 3 Video", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "bfl/flux-3-video" ], "description": "Must be `bfl/flux-3-video`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ {}, { "anyOf": [ { "type": "object", "properties": { "width": { "enum": [ 1470 ] }, "height": { "enum": [ 630 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1360 ] }, "height": { "enum": [ 680 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1280 ] }, "height": { "enum": [ 720 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1112 ] }, "height": { "enum": [ 834 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 960 ] }, "height": { "enum": [ 960 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 834 ] }, "height": { "enum": [ 1112 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 720 ] }, "height": { "enum": [ 1280 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 2520 ] }, "height": { "enum": [ 1080 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 2160 ] }, "height": { "enum": [ 1080 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1920 ] }, "height": { "enum": [ 1080 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1440 ] }, "height": { "enum": [ 1080 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1440 ] }, "height": { "enum": [ 1440 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1080 ] }, "height": { "enum": [ 1440 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1080 ] }, "height": { "enum": [ 1920 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 0 ] }, "height": { "enum": [ 0 ] } } } ] }, {} ], "required": [ "prompt" ], "properties": { "width": { "type": "integer", "title": "Width", "maximum": 9007199254740991, "minimum": 0, "description": "The width of the image to generate in pixels", "enum": [ 1470, 1360, 1280, 1112, 960, 834, 720, 2520, 2160, 1920, 1440, 1080, 0 ] }, "height": { "type": "integer", "title": "Height", "maximum": 9007199254740991, "minimum": 0, "description": "The height of the image to generate in pixels", "enum": [ 630, 680, 720, 834, 960, 1112, 1280, 1080, 1440, 1920, 0 ] }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 5000, "minLength": 1, "description": "The prompt to use for the generation" }, "duration": { "type": "integer", "title": "Duration", "description": "Duration of the video in seconds", "enum": [ 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20 ], "default": 8 }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 1 }, "guidances": { "type": "object", "properties": { "end_frame": { "type": "array", "items": { "type": "object", "title": "End Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "End Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 }, "start_frame": { "type": "array", "items": { "type": "object", "title": "Start Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "Start Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 }, "video_reference_base": { "type": "array", "allOf": [ { "type": "array", "items": { "type": "object", "title": "Video Reference Base", "required": [ "video" ], "properties": { "video": { "type": "object", "title": "Video reference", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Video URL (enriched by backend when video is resolved" }, "type": { "enum": [ "UPLOADED", "GENERATED" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" }, "duration": { "type": "number" }, "motion_has_audio": { "type": "boolean" } }, "description": "A reference to a video", "additionalProperties": false } } }, "title": "Video Reference Base", "description": "Base video to be edited." }, { "items": { "type": "object", "properties": { "video": { "type": "object", "required": [ "duration" ], "properties": { "width": { "type": "integer", "maximum": 2160, "minimum": 480 }, "height": { "type": "integer", "maximum": 2160, "minimum": 480 }, "duration": { "type": "number", "maximum": 15.05, "minimum": 1 } } } } } }, {} ], "maxItems": 1, "description": "Each item must be at most 15 seconds. Each item must be under 50 MB." } }, "additionalProperties": false }, "resolution": { "enum": [ "720p", "1080p" ], "type": "string", "default": "720p", "description": "Output resolution, used when width and height are not supplied. Explicit width and height take precedence over this value." }, "motion_has_audio": { "type": "boolean", "title": "Audio", "default": true, "description": "Whether the video generation will include audio." } } } }, "example": { "model": "bfl/flux-3-video", "parameters": { "prompt": "your prompt here", "duration": 8, "resolution": "720p", "motion_has_audio": true } } }, "Bfl_flux3ImageGenerationRequest": { "title": "FLUX 3 Image", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "bfl/flux-3-image" ], "description": "Must be `bfl/flux-3-image`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ {}, {}, {}, {}, {} ], "required": [ "prompt" ], "properties": { "width": { "type": "integer", "title": "Width", "maximum": 9007199254740991, "minimum": 0, "description": "The width of the image to generate in pixels", "enum": [ 672, 720, 768, 832, 864, 880, 912, 1024, 1152, 1184, 1216, 1248, 1344, 1360, 1456, 1536, 1568, 1680, 1728, 1776, 1824, 2048, 2288, 2368, 2416, 2512, 2688, 2736, 2896, 3072, 3136, 3344, 3456, 3552, 3664, 4096, 4576, 4736, 4848, 5024, 5456, 5792, 6256 ], "default": 1024 }, "height": { "type": "integer", "title": "Height", "maximum": 9007199254740991, "minimum": 0, "description": "The height of the image to generate in pixels", "enum": [ 672, 720, 768, 832, 864, 880, 912, 1024, 1152, 1184, 1216, 1248, 1344, 1360, 1456, 1536, 1568, 1680, 1728, 1776, 1824, 2048, 2288, 2368, 2416, 2512, 2688, 2736, 2896, 3072, 3136, 3344, 3456, 3552, 3664, 4096, 4576, 4736, 4848, 5024, 5456, 5792, 6256 ], "default": 1024 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 4, "maximum": 8 }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "properties": { "image_reference": { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" } }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 10 } } }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" } }, "description": "FLUX 3 Image model parameters" } }, "example": { "model": "bfl/flux-3-image", "parameters": { "width": 1024, "height": 1024, "prompt": "your prompt here", "quantity": 4 } } }, "Wan2_6GenerationRequest": { "title": "Wan 2.6", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "wan-2.6" ], "description": "Must be `wan-2.6`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ { "anyOf": [ { "type": "object", "properties": { "width": { "enum": [ 1280 ] }, "height": { "enum": [ 720 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1920 ] }, "height": { "enum": [ 1080 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 720 ] }, "height": { "enum": [ 1280 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1080 ] }, "height": { "enum": [ 1920 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 960 ] }, "height": { "enum": [ 960 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1440 ] }, "height": { "enum": [ 1440 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 960 ] }, "height": { "enum": [ 720 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1440 ] }, "height": { "enum": [ 1080 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 720 ] }, "height": { "enum": [ 960 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 1080 ] }, "height": { "enum": [ 1440 ] } } }, { "type": "object", "properties": { "width": { "enum": [ 0 ] }, "height": { "enum": [ 0 ] } } } ] }, {}, {}, {} ], "required": [ "prompt" ], "properties": { "seed": { "type": "integer", "title": "Seed", "description": "The seed value for generation", "maximum": 2147483647, "minimum": 0 }, "width": { "type": "integer", "title": "Width", "maximum": 9007199254740991, "minimum": 0, "description": "The width of the image to generate in pixels", "enum": [ 1280, 720, 960, 1920, 1080, 1440, 0 ] }, "height": { "type": "integer", "title": "Height", "maximum": 9007199254740991, "minimum": 0, "description": "The height of the image to generate in pixels", "enum": [ 720, 1280, 960, 1080, 1920, 1440, 0 ] }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 1500, "minLength": 1, "description": "The prompt to use for the generation" }, "duration": { "type": "integer", "title": "Duration", "description": "Duration of the video in seconds", "enum": [ 5, 10, 15 ], "default": 5 }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 1 }, "guidances": { "type": "object", "properties": { "start_frame": { "type": "array", "items": { "type": "object", "title": "Start Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "Start Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 }, "audio_reference": { "type": "array", "allOf": [ { "type": "array", "items": { "type": "object", "title": "Audio reference", "required": [ "audio" ], "properties": { "audio": { "type": "object", "title": "Audio reference", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Audio URL (enriched by backend when audio is resolved)" }, "type": { "enum": [ "UPLOADED", "GENERATED" ], "type": "string" }, "duration": { "type": "number" } }, "description": "A reference to audio", "additionalProperties": false } } }, "title": "Audio Reference", "description": "Specifies a list of audio references for guidance" } ], "maxItems": 1, "description": "A background-music clip for the video. Cannot be combined with a video reference. Each item must be 3–30 seconds." }, "video_reference_base": { "type": "array", "allOf": [ { "type": "array", "items": { "type": "object", "title": "Video Reference Base", "required": [ "video" ], "properties": { "video": { "type": "object", "title": "Video reference", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Video URL (enriched by backend when video is resolved" }, "type": { "enum": [ "UPLOADED", "GENERATED" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" }, "duration": { "type": "number" }, "motion_has_audio": { "type": "boolean" } }, "description": "A reference to a video", "additionalProperties": false } } }, "title": "Video Reference Base", "description": "Base video to be edited." } ], "maxItems": 3 } }, "additionalProperties": false }, "resolution": { "enum": [ "720p", "1080p" ], "type": "string", "default": "720p", "description": "Output resolution, used when width and height are not supplied (image-to-video). Determines the cost tier." }, "negative_prompt": { "type": "string", "title": "Negative Prompt", "maxLength": 500, "description": "The negative prompt to use for the generation", "default": "" } } } }, "example": { "model": "wan-2.6", "parameters": { "prompt": "your prompt here", "duration": 5, "resolution": "720p", "negative_prompt": "" } } }, "Seedance1_0ProGenerationRequest": { "title": "Seedance 1.0 Pro", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "seedance-1.0-pro" ], "description": "Must be `seedance-1.0-pro`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt", "quantity" ], "properties": { "mode": { "type": "string", "title": "Quality", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Deprecated. Width and height are the canonical inputs for this model. This field is retained for backwards compatibility with mobile clients and Production API consumers that still send `mode`. Validation is silent: omitted is the new norm; explicit values are still consistency-checked against width and height.", "enum": [ "RESOLUTION_480", "RESOLUTION_720", "RESOLUTION_1080" ], "default": "RESOLUTION_720", "deprecated": true }, "seed": { "type": "number", "title": "Seed", "description": "The seed value for generation", "default": -1, "maximum": 4294967295, "minimum": -1 }, "width": { "type": "integer", "default": 1248 }, "height": { "type": "integer", "default": 704 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 5000, "minLength": 1, "description": "The prompt to use for the generation" }, "duration": { "type": "integer", "title": "Duration", "description": "Duration of the video in seconds", "enum": [ 4, 6, 8, 10 ], "default": 8 }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 1 }, "guidances": { "type": "object", "properties": { "end_frame": { "type": "array", "items": { "type": "object", "title": "End Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "End Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 }, "start_frame": { "type": "array", "items": { "type": "object", "title": "Start Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "Start Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 } }, "additionalProperties": false }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" } } } }, "example": { "model": "seedance-1.0-pro", "parameters": { "width": 1248, "height": 704, "prompt": "your prompt here", "duration": 8, "quantity": 1 } } }, "Seedance1_0ProFastGenerationRequest": { "title": "Seedance 1.0 Pro Fast", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "seedance-1.0-pro-fast" ], "description": "Must be `seedance-1.0-pro-fast`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt", "quantity" ], "properties": { "mode": { "type": "string", "title": "Quality", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Deprecated. Width and height are the canonical inputs for this model. This field is retained for backwards compatibility with mobile clients and Production API consumers that still send `mode`. Validation is silent: omitted is the new norm; explicit values are still consistency-checked against width and height.", "enum": [ "RESOLUTION_480", "RESOLUTION_720", "RESOLUTION_1080" ], "anyOf": [ { "enum": [ "RESOLUTION_480" ] }, { "enum": [ "RESOLUTION_720" ] }, { "enum": [ "RESOLUTION_1080" ] } ], "default": "RESOLUTION_720", "deprecated": true }, "seed": { "type": "number", "title": "Seed", "description": "The seed value for generation", "default": -1, "maximum": 4294967295, "minimum": -1 }, "width": { "type": "integer", "default": 1248 }, "height": { "type": "integer", "default": 704 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 5000, "minLength": 1, "description": "The prompt to use for the generation" }, "duration": { "type": "integer", "title": "Duration", "description": "Duration of the video in seconds", "enum": [ 4, 6, 8, 10 ], "default": 8 }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 1 }, "guidances": { "type": "object", "properties": { "start_frame": { "type": "array", "items": { "type": "object", "title": "Start Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "Start Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 } }, "additionalProperties": false }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" } } } }, "example": { "model": "seedance-1.0-pro-fast", "parameters": { "width": 1248, "height": 704, "prompt": "your prompt here", "duration": 8, "quantity": 1 } } }, "Seedance2_0GenerationRequest": { "title": "Seedance 2.0", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "seedance-2.0" ], "description": "Must be `seedance-2.0`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ {}, {}, {}, {} ], "required": [ "prompt", "quantity" ], "properties": { "mode": { "type": "string", "title": "Generation Mode", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Deprecated. Width and height are the canonical inputs for this model. This field is retained for backwards compatibility with mobile clients and Production API consumers that still send `mode`. Validation is silent: omitted is the new norm; explicit values are still consistency-checked against width and height.", "enum": [ "RESOLUTION_480", "RESOLUTION_720", "RESOLUTION_1080", "RESOLUTION_2160" ], "anyOf": [ { "enum": [ "RESOLUTION_720" ] }, { "enum": [ "RESOLUTION_480" ] }, { "enum": [ "RESOLUTION_1080" ] }, { "enum": [ "RESOLUTION_2160" ] } ], "default": "RESOLUTION_720", "deprecated": true }, "seed": { "type": "number", "title": "Seed", "description": "The seed value for generation", "default": -1, "maximum": 4294967295, "minimum": -1 }, "width": { "type": "integer", "default": 1280 }, "height": { "type": "integer", "default": 720 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 5000, "minLength": 1, "description": "The prompt to use for the generation" }, "duration": { "type": "integer", "title": "Duration", "description": "Duration of the video in seconds", "enum": [ 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ], "default": 8 }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 1 }, "guidances": { "type": "object", "properties": { "end_frame": { "type": "array", "items": { "type": "object", "title": "End Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "End Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 }, "start_frame": { "type": "array", "items": { "type": "object", "title": "Start Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "Start Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 }, "audio_reference": { "type": "array", "allOf": [ { "type": "array", "items": { "type": "object", "title": "Audio reference", "required": [ "audio" ], "properties": { "audio": { "type": "object", "title": "Audio reference", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Audio URL (enriched by backend when audio is resolved)" }, "type": { "enum": [ "UPLOADED", "GENERATED" ], "type": "string" }, "duration": { "type": "number" } }, "description": "A reference to audio", "additionalProperties": false } } }, "title": "Audio Reference", "description": "Specifies a list of audio references for guidance" } ], "maxItems": 1, "description": "An audio clip used as a generation reference. Requires an image reference or a video reference; a start or end frame does not count." }, "image_reference": { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" } }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 4 }, "video_reference_base": { "type": "array", "allOf": [ { "type": "array", "items": { "type": "object", "title": "Video Reference Base", "required": [ "video" ], "properties": { "video": { "type": "object", "title": "Video reference", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Video URL (enriched by backend when video is resolved" }, "type": { "enum": [ "UPLOADED", "GENERATED" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" }, "duration": { "type": "number" }, "motion_has_audio": { "type": "boolean" } }, "description": "A reference to a video", "additionalProperties": false } } }, "title": "Video Reference Base", "description": "Base video to be edited." } ], "maxItems": 3, "properties": { "0": { "type": "object" } } } }, "additionalProperties": false }, "motion_has_audio": { "type": "boolean", "title": "Audio", "default": true, "description": "Whether the video generation will include audio." } } } }, "example": { "model": "seedance-2.0", "parameters": { "width": 1280, "height": 720, "prompt": "your prompt here", "duration": 8, "quantity": 1, "motion_has_audio": true } } }, "Seedance2_0FastGenerationRequest": { "title": "Seedance 2.0 Fast", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "seedance-2.0-fast" ], "description": "Must be `seedance-2.0-fast`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ {}, {} ], "required": [ "prompt", "quantity" ], "properties": { "mode": { "type": "string", "title": "Generation Mode", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Deprecated. Width and height are the canonical inputs for this model. This field is retained for backwards compatibility with mobile clients and Production API consumers that still send `mode`. Validation is silent: omitted is the new norm; explicit values are still consistency-checked against width and height.", "enum": [ "RESOLUTION_480", "RESOLUTION_720" ], "anyOf": [ { "enum": [ "RESOLUTION_720" ] }, { "enum": [ "RESOLUTION_480" ] } ], "default": "RESOLUTION_720", "deprecated": true }, "seed": { "type": "number", "title": "Seed", "description": "The seed value for generation", "default": -1, "maximum": 4294967295, "minimum": -1 }, "width": { "type": "integer", "default": 1280 }, "height": { "type": "integer", "default": 720 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 5000, "minLength": 1, "description": "The prompt to use for the generation" }, "duration": { "type": "integer", "title": "Duration", "description": "Duration of the video in seconds", "enum": [ 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ], "default": 8 }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 1 }, "guidances": { "type": "object", "properties": { "end_frame": { "type": "array", "items": { "type": "object", "title": "End Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "End Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 }, "start_frame": { "type": "array", "items": { "type": "object", "title": "Start Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "Start Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 }, "audio_reference": { "type": "array", "allOf": [ { "type": "array", "items": { "type": "object", "title": "Audio reference", "required": [ "audio" ], "properties": { "audio": { "type": "object", "title": "Audio reference", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Audio URL (enriched by backend when audio is resolved)" }, "type": { "enum": [ "UPLOADED", "GENERATED" ], "type": "string" }, "duration": { "type": "number" } }, "description": "A reference to audio", "additionalProperties": false } } }, "title": "Audio Reference", "description": "Specifies a list of audio references for guidance" } ], "maxItems": 1, "description": "An audio clip used as a generation reference. Requires an image reference or a video reference; a start or end frame does not count." }, "image_reference": { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" } }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 4 }, "video_reference_base": { "type": "array", "allOf": [ { "type": "array", "items": { "type": "object", "title": "Video Reference Base", "required": [ "video" ], "properties": { "video": { "type": "object", "title": "Video reference", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Video URL (enriched by backend when video is resolved" }, "type": { "enum": [ "UPLOADED", "GENERATED" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" }, "duration": { "type": "number" }, "motion_has_audio": { "type": "boolean" } }, "description": "A reference to a video", "additionalProperties": false } } }, "title": "Video Reference Base", "description": "Base video to be edited." } ], "maxItems": 3, "properties": { "0": { "type": "object" } } } }, "additionalProperties": false }, "motion_has_audio": { "type": "boolean", "title": "Audio", "default": true, "description": "Whether the video generation will include audio." } } } }, "example": { "model": "seedance-2.0-fast", "parameters": { "width": 1280, "height": 720, "prompt": "your prompt here", "duration": 8, "quantity": 1, "motion_has_audio": true } } }, "Seedance2_0MiniGenerationRequest": { "title": "Seedance 2.0 Mini", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "seedance-2.0-mini" ], "description": "Must be `seedance-2.0-mini`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ {}, {} ], "required": [ "prompt", "quantity" ], "properties": { "seed": { "type": "number", "title": "Seed", "description": "The seed value for generation", "default": -1, "maximum": 4294967295, "minimum": -1 }, "width": { "type": "integer", "default": 1280 }, "height": { "type": "integer", "default": 720 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 5000, "minLength": 1, "description": "The prompt to use for the generation" }, "duration": { "type": "integer", "title": "Duration", "description": "Duration of the video in seconds", "enum": [ 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ], "default": 8 }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 1 }, "guidances": { "type": "object", "properties": { "end_frame": { "type": "array", "items": { "type": "object", "title": "End Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "End Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 }, "start_frame": { "type": "array", "items": { "type": "object", "title": "Start Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "Start Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 }, "audio_reference": { "type": "array", "allOf": [ { "type": "array", "items": { "type": "object", "title": "Audio reference", "required": [ "audio" ], "properties": { "audio": { "type": "object", "title": "Audio reference", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Audio URL (enriched by backend when audio is resolved)" }, "type": { "enum": [ "UPLOADED", "GENERATED" ], "type": "string" }, "duration": { "type": "number" } }, "description": "A reference to audio", "additionalProperties": false } } }, "title": "Audio Reference", "description": "Specifies a list of audio references for guidance" } ], "maxItems": 1, "description": "An audio clip used as a generation reference. Requires an image reference or a video reference; a start or end frame does not count." }, "image_reference": { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" } }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 4 }, "video_reference_base": { "type": "array", "allOf": [ { "type": "array", "items": { "type": "object", "title": "Video Reference Base", "required": [ "video" ], "properties": { "video": { "type": "object", "title": "Video reference", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Video URL (enriched by backend when video is resolved" }, "type": { "enum": [ "UPLOADED", "GENERATED" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" }, "duration": { "type": "number" }, "motion_has_audio": { "type": "boolean" } }, "description": "A reference to a video", "additionalProperties": false } } }, "title": "Video Reference Base", "description": "Base video to be edited." } ], "maxItems": 3, "properties": { "0": { "type": "object" } } } }, "additionalProperties": false }, "motion_has_audio": { "type": "boolean", "title": "Audio", "default": true, "description": "Whether the video generation will include audio." } } } }, "example": { "model": "seedance-2.0-mini", "parameters": { "width": 1280, "height": 720, "prompt": "your prompt here", "duration": 8, "quantity": 1, "motion_has_audio": true } } }, "Bytedance_seedance2_5GenerationRequest": { "title": "Seedance 2.5", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "bytedance/seedance-2.5" ], "description": "Must be `bytedance/seedance-2.5`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ {} ], "required": [ "prompt", "quantity" ], "properties": { "seed": { "type": "number", "title": "Seed", "description": "The seed value for generation", "default": -1, "maximum": 4294967295, "minimum": -1 }, "width": { "type": "integer", "default": 1280 }, "height": { "type": "integer", "default": 720 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "duration": { "type": "integer", "title": "Duration", "description": "Duration of the video in seconds", "enum": [ 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30 ], "default": 8 }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 1 }, "guidances": { "type": "object", "properties": { "end_frame": { "type": "array", "items": { "type": "object", "title": "End Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "End Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 }, "start_frame": { "type": "array", "items": { "type": "object", "title": "Start Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "Start Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 }, "audio_reference": { "type": "array", "allOf": [ { "type": "array", "items": { "type": "object", "title": "Audio reference", "required": [ "audio" ], "properties": { "audio": { "type": "object", "title": "Audio reference", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Audio URL (enriched by backend when audio is resolved)" }, "type": { "enum": [ "UPLOADED", "GENERATED" ], "type": "string" }, "duration": { "type": "number" } }, "description": "A reference to audio", "additionalProperties": false } } }, "title": "Audio Reference", "description": "Specifies a list of audio references for guidance" } ], "maxItems": 10, "description": "Audio clips used as generation references. Requires an image reference or a video reference; a start or end frame does not count." }, "image_reference": { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" } }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 30 }, "video_reference_base": { "type": "array", "allOf": [ { "type": "array", "items": { "type": "object", "title": "Video Reference Base", "required": [ "video" ], "properties": { "video": { "type": "object", "title": "Video reference", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Video URL (enriched by backend when video is resolved" }, "type": { "enum": [ "UPLOADED", "GENERATED" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" }, "duration": { "type": "number" }, "motion_has_audio": { "type": "boolean" } }, "description": "A reference to a video", "additionalProperties": false } } }, "title": "Video Reference Base", "description": "Base video to be edited." } ], "maxItems": 10 } }, "additionalProperties": false }, "omni_edit": { "type": "boolean", "description": "Sent by the omni edit surface (true) and the generate screen (false). When a video_reference_base item omits type, omni_edit=true derives BASE (edit-video); false/absent derives FEATURE (reference-to-video)." }, "motion_has_audio": { "type": "boolean", "title": "Audio", "default": true, "description": "Whether the video generation will include audio." } } } }, "example": { "model": "bytedance/seedance-2.5", "parameters": { "width": 1280, "height": 720, "prompt": "your prompt here", "duration": 8, "quantity": 1, "motion_has_audio": true } } }, "Bytedance_videoUpscalerGenerationRequest": { "title": "ByteDance Video Upscaler", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "bytedance/video-upscaler" ], "description": "Must be `bytedance/video-upscaler`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {} ], "required": [ "guidances", "duration" ], "properties": { "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "duration": { "type": "integer", "title": "Duration", "description": "Length of the video in seconds. The upscaled video keeps this length. The charge uses this many seconds.", "default": 1, "maximum": 60, "minimum": 1 }, "fidelity": { "enum": [ "high", "medium" ], "type": "string", "default": "high", "description": "Enhancement intensity. High stays close to the source. Medium applies a stronger change." }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 1 }, "bit_depth": { "enum": [ 8, 10, 12 ], "type": "integer", "default": 8, "description": "Color bit depth of the output video. 10-bit and 12-bit output require Pro enhancement." }, "guidances": { "type": "object", "required": [ "video_reference_base" ], "properties": { "video_reference_base": { "type": "array", "allOf": [ { "type": "array", "items": { "type": "object", "title": "Video Reference Base", "required": [ "video" ], "properties": { "video": { "type": "object", "title": "Video reference", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Video URL (enriched by backend when video is resolved" }, "type": { "enum": [ "UPLOADED", "GENERATED" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" }, "duration": { "type": "number" }, "motion_has_audio": { "type": "boolean" } }, "description": "A reference to a video", "additionalProperties": false } } }, "title": "Video Reference Base", "description": "Base video to be edited." }, { "items": { "type": "object", "properties": { "video": { "type": "object", "required": [ "duration" ], "properties": { "duration": { "type": "number", "exclusiveMinimum": true, "minimum": 0 } } } } }, "maxItems": 1, "minItems": 1 } ] } }, "additionalProperties": false }, "resolution": { "enum": [ "1080p", "2k", "4k" ], "type": "string", "default": "1080p", "description": "The resolution of the upscaled video, not the source video. Fal publishes rates for 1080p, 2K, and 4K." }, "target_fps": { "type": "number", "default": 30, "maximum": 120, "minimum": 24, "description": "Frame rate of the upscaled video, not the source. Fal accepts 24 to 120. A frame rate of 60 or higher uses the 60 fps charge. A lower frame rate uses the 30 fps charge." }, "scale_ratio": { "type": "number", "maximum": 10, "minimum": 1.1, "description": "How many times larger the output is than the source video. 2 means twice as large. This replaces the target resolution. Fal accepts 1.1 to 10, and only for 1080p, 2K, or 4K. Fal does not publish a separate rate, so the charge follows the selected target resolution, frame rate, and enhancement." }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "OFF", "description": "Whether to enhance the prompt or not" }, "enhancement_tier": { "enum": [ "fast", "standard", "pro" ], "type": "string", "default": "standard", "description": "Enhancement quality. Pro uses the Pro charge. Pro enables 10-bit and 12-bit output." }, "enhancement_preset": { "enum": [ "general", "ugc", "short_series", "aigc", "old_film" ], "type": "string", "default": "general", "description": "Enhancement preset for the kind of source video." } }, "additionalProperties": false } }, "example": { "model": "bytedance/video-upscaler", "parameters": { "duration": 1, "fidelity": "high", "bit_depth": 8, "guidances": "your guidances here", "resolution": "1080p", "target_fps": 30, "enhancement_tier": "standard", "enhancement_preset": "general" } } }, "GrokImagine1_5GenerationRequest": { "title": "Grok Imagine 1.5", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "grok-imagine-1.5" ], "description": "Must be `grok-imagine-1.5`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ { "anyOf": [ { "not": { "anyOf": [ { "required": [ "width" ] }, { "required": [ "height" ] } ] } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 0 ] }, "height": { "enum": [ 0 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 544 ] }, "height": { "enum": [ 544 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 736 ] }, "height": { "enum": [ 400 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 400 ] }, "height": { "enum": [ 736 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 960 ] }, "height": { "enum": [ 960 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1280 ] }, "height": { "enum": [ 720 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 720 ] }, "height": { "enum": [ 1280 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1888 ] }, "height": { "enum": [ 1072 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1424 ] }, "height": { "enum": [ 1424 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1072 ] }, "height": { "enum": [ 1888 ] } } } ] }, {}, {} ], "required": [ "prompt", "guidances" ], "properties": { "width": { "enum": [ 0, 400, 544, 720, 736, 960, 1072, 1280, 1424, 1888 ], "type": "integer", "default": 736 }, "height": { "enum": [ 0, 400, 544, 720, 736, 960, 1072, 1280, 1424, 1888 ], "type": "integer", "default": 400 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 5000, "minLength": 1, "description": "The prompt to use for the generation" }, "duration": { "type": "integer", "title": "Duration", "description": "Duration of the video in seconds", "enum": [ 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ], "default": 6 }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 1 }, "guidances": { "type": "object", "required": [ "start_frame" ], "properties": { "start_frame": { "type": "array", "items": { "type": "object", "title": "Start Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "Start Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1, "minItems": 1 } } }, "motion_has_audio": { "type": "boolean", "title": "Audio", "default": true, "description": "Whether the video generation will include audio." } }, "description": "Architecture properties of the Grok Imagine 1.5 model" } }, "example": { "model": "grok-imagine-1.5", "parameters": { "width": 736, "height": 400, "prompt": "your prompt here", "duration": 6, "guidances": "your guidances here" } } }, "Seedream4_0GenerationRequest": { "title": "Seedream 4.0", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "seedream-4.0" ], "description": "Must be `seedream-4.0`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt" ], "properties": { "seed": { "type": "integer", "title": "Seed", "description": "The seed value for generation", "maximum": 2147483638, "minimum": 0 }, "width": { "type": "integer", "title": "Width", "maximum": 14142, "minimum": 32, "description": "The width of the image to generate in pixels", "default": 1024 }, "height": { "type": "integer", "title": "Height", "maximum": 14142, "minimum": 32, "description": "The height of the image to generate in pixels", "default": 1024 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 8 }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "properties": { "image_reference": { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" } }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 6 } } }, "style_ids": { "type": "array", "items": { "enum": [ "a5632c7c-ddbb-4e2f-ba34-8456ab3ac436", "6fedbf1f-4a17-45ec-84fb-92fe524a29ef", "111dc692-d470-4eec-b791-3475abac4c46", "594c4a08-a522-4e0e-b7ff-e4dac4b6b622", "ab5a4220-7c42-41e5-a578-eddb9fed3d75", "5bdc3f2a-1be6-4d1c-8e77-992a30824a2c", "dee282d3-891f-4f73-ba02-7f8131e5541b", "556c1ee5-ec38-42e8-955a-1e82dad0ffa1" ], "type": "string", "format": "uuid" }, "title": "Style IDs for Image Models", "default": [ "111dc692-d470-4eec-b791-3475abac4c46" ], "description": "An array of style UUIDs for image models (limited to 1 style)." }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" } }, "description": "Seedream 4.0 Model Parameters" } }, "example": { "model": "seedream-4.0", "parameters": { "width": 1024, "height": 1024, "prompt": "your prompt here", "quantity": 1, "style_ids": [ "111dc692-d470-4eec-b791-3475abac4c46" ] } } }, "Seedream4_5GenerationRequest": { "title": "Seedream 4.5", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "seedream-4.5" ], "description": "Must be `seedream-4.5`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt" ], "properties": { "seed": { "type": "integer", "title": "Seed", "description": "The seed value for generation", "maximum": 2147483638, "minimum": 0 }, "width": { "type": "integer", "title": "Width", "maximum": 14142, "minimum": 32, "description": "The width of the image to generate in pixels", "default": 2048 }, "height": { "type": "integer", "title": "Height", "maximum": 14142, "minimum": 32, "description": "The height of the image to generate in pixels", "default": 2048 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 8 }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "properties": { "image_reference": { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" } }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 6 } } }, "style_ids": { "type": "array", "items": { "enum": [ "a5632c7c-ddbb-4e2f-ba34-8456ab3ac436", "6fedbf1f-4a17-45ec-84fb-92fe524a29ef", "111dc692-d470-4eec-b791-3475abac4c46", "594c4a08-a522-4e0e-b7ff-e4dac4b6b622", "ab5a4220-7c42-41e5-a578-eddb9fed3d75", "5bdc3f2a-1be6-4d1c-8e77-992a30824a2c", "dee282d3-891f-4f73-ba02-7f8131e5541b", "556c1ee5-ec38-42e8-955a-1e82dad0ffa1" ], "type": "string", "format": "uuid" }, "title": "Style IDs for Image Models", "default": [ "111dc692-d470-4eec-b791-3475abac4c46" ], "description": "An array of style UUIDs for image models (limited to 1 style)." }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" } }, "description": "Seedream 4.5 Model Parameters" } }, "example": { "model": "seedream-4.5", "parameters": { "width": 2048, "height": 2048, "prompt": "your prompt here", "quantity": 1, "style_ids": [ "111dc692-d470-4eec-b791-3475abac4c46" ] } } }, "Seedream5_0ProGenerationRequest": { "title": "Seedream 5.0 Pro", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "seedream-5.0-pro" ], "description": "Must be `seedream-5.0-pro`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ {} ], "required": [ "prompt" ], "properties": { "mode": { "type": "string", "title": "Quality", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Use this instead of `mode` for all third-party models!", "enum": [ "FAST", "QUALITY" ], "default": "QUALITY" }, "seed": { "type": "integer", "title": "Seed", "description": "The seed value for generation", "maximum": 2147483637, "minimum": 0 }, "width": { "type": "integer", "title": "Width", "maximum": 2048, "minimum": 768, "description": "The width of the image to generate in pixels", "default": 2048 }, "height": { "type": "integer", "title": "Height", "maximum": 2048, "minimum": 768, "description": "The height of the image to generate in pixels", "default": 2048 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 6 }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "properties": { "image_reference": { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" } }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 10 } } }, "annotation": { "type": "boolean", "title": "Annotation", "description": "Whether an image reference has marks drawn on it that show what to change" }, "output_format": { "enum": [ "jpeg", "png" ], "type": "string", "default": "jpeg" }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" } }, "description": "Seedream 5.0 Pro model parameters" } }, "example": { "model": "seedream-5.0-pro", "parameters": { "mode": "QUALITY", "width": 2048, "height": 2048, "prompt": "your prompt here", "quantity": 1 } } }, "Bytedance_seedream5_0FlashGenerationRequest": { "title": "Seedream 5.0 Flash", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "bytedance/seedream-5.0-flash" ], "description": "Must be `bytedance/seedream-5.0-flash`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ {}, {} ], "required": [ "prompt" ], "properties": { "width": { "type": "integer", "title": "Width", "maximum": 3008, "minimum": 1024, "description": "The width of the image to generate in pixels", "default": 2048 }, "height": { "type": "integer", "title": "Height", "maximum": 3008, "minimum": 1024, "description": "The height of the image to generate in pixels", "default": 2048 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 8 }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "properties": { "image_reference": { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" } }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 10 } } }, "annotation": { "type": "boolean", "title": "Annotation", "description": "Whether an image reference has marks drawn on it that show what to change" }, "output_format": { "enum": [ "jpeg", "png" ], "type": "string", "default": "jpeg" }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" } }, "description": "Seedream 5.0 Flash model parameters" } }, "example": { "model": "bytedance/seedream-5.0-flash", "parameters": { "width": 2048, "height": 2048, "prompt": "your prompt here", "quantity": 1 } } }, "GptImage1_5GenerationRequest": { "title": "GPT Image-1.5", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "gpt-image-1.5" ], "description": "Must be `gpt-image-1.5`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt" ], "properties": { "width": { "type": "integer", "title": "Width", "maximum": 1536, "minimum": 1024, "description": "The width of the image to generate in pixels", "default": 1024, "multipleOf": 8 }, "height": { "type": "integer", "title": "Height", "maximum": 1536, "minimum": 1024, "description": "The height of the image to generate in pixels", "default": 1024, "multipleOf": 8 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "quality": { "type": "string", "title": "Quality", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Use this instead of `mode` for all third-party models!", "enum": [ "LOW", "MEDIUM", "HIGH" ], "anyOf": [ { "enum": [ "LOW" ] }, { "enum": [ "MEDIUM" ] }, { "enum": [ "HIGH" ] } ], "default": "MEDIUM" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 4, "maximum": 8 }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "properties": { "image_reference": { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" } }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 6 } } }, "style_ids": { "type": "array", "items": { "enum": [ "debdf72a-91a4-467b-bf61-cc02bdeb69c6", "3cbb655a-7ca4-463f-b697-8a03ad67327c", "a5632c7c-ddbb-4e2f-ba34-8456ab3ac436", "6fedbf1f-4a17-45ec-84fb-92fe524a29ef", "111dc692-d470-4eec-b791-3475abac4c46", "594c4a08-a522-4e0e-b7ff-e4dac4b6b622", "09d2b5b5-d7c5-4c02-905d-9f84051640f4", "703d6fe5-7f1c-4a9e-8da0-5331f214d5cf", "7d7c2bc5-4b12-4ac3-81a9-630057e9e89f", "645e4195-f63d-4715-a3f2-3fb1e6eb8c70", "556c1ee5-ec38-42e8-955a-1e82dad0ffa1", "ab5a4220-7c42-41e5-a578-eddb9fed3d75", "4edb03c9-8a26-4041-9d01-f85b5d4abd71", "0d34f8e1-46d4-428f-8ddd-4b11811fa7c9", "22a9a7d2-2166-4d86-80ff-22e2643adbcf", "7c3f932b-a572-47cb-9b9b-f20211e63b5b", "581ba6d6-5aac-4492-bebe-54c424a0d46e", "b504f83c-3326-4947-82e1-7fe9e839ec0f", "5bdc3f2a-1be6-4d1c-8e77-992a30824a2c", "dee282d3-891f-4f73-ba02-7f8131e5541b", "1db308ce-c7ad-4d10-96fd-592fa6b75cc4" ], "type": "string", "format": "uuid" }, "title": "Style IDs for Image Models", "default": [ "111dc692-d470-4eec-b791-3475abac4c46" ], "description": "An array of style UUIDs for image models (limited to 1 style)." }, "transparency": { "type": "boolean", "title": "Transparency", "description": "Whether the image can be generated with a transparent background" }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" } }, "description": "GPT-Image-1.5 Model Parameters" } }, "example": { "model": "gpt-image-1.5", "parameters": { "width": 1024, "height": 1024, "prompt": "your prompt here", "quality": "MEDIUM", "quantity": 4, "style_ids": [ "111dc692-d470-4eec-b791-3475abac4c46" ] } } }, "GptImage2GenerationRequest": { "title": "GPT Image 2", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "gpt-image-2" ], "description": "Must be `gpt-image-2`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt" ], "properties": { "width": { "type": "integer", "title": "Width", "maximum": 9007199254740991, "minimum": 0, "description": "The width of the image to generate in pixels", "enum": [ 768, 832, 848, 864, 896, 928, 1024, 1088, 1136, 1152, 1184, 1200, 1248, 1264, 1344, 1376, 1536, 1584, 1648, 1696, 1792, 1856, 2016, 2048, 2336, 2448, 2560, 2880, 3200, 3264, 3504, 3584, 3808 ], "default": 1024 }, "height": { "type": "integer", "title": "Height", "maximum": 9007199254740991, "minimum": 0, "description": "The height of the image to generate in pixels", "enum": [ 640, 672, 768, 832, 848, 864, 896, 928, 1024, 1136, 1152, 1184, 1200, 1248, 1264, 1280, 1344, 1376, 1536, 1584, 1632, 1648, 1696, 1792, 1824, 1856, 1920, 2016, 2048, 2336, 2448, 2560, 2880, 3200, 3264, 3504, 3584 ], "default": 1024 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "quality": { "type": "string", "title": "Quality", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Use this instead of `mode` for all third-party models!", "enum": [ "LOW", "MEDIUM", "HIGH" ], "anyOf": [ { "enum": [ "LOW" ] }, { "enum": [ "MEDIUM" ] }, { "enum": [ "HIGH" ] } ], "default": "MEDIUM" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 4, "maximum": 8 }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "properties": { "image_reference": { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" } }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 6 } } }, "style_ids": { "type": "array", "items": { "enum": [ "debdf72a-91a4-467b-bf61-cc02bdeb69c6", "3cbb655a-7ca4-463f-b697-8a03ad67327c", "a5632c7c-ddbb-4e2f-ba34-8456ab3ac436", "6fedbf1f-4a17-45ec-84fb-92fe524a29ef", "111dc692-d470-4eec-b791-3475abac4c46", "594c4a08-a522-4e0e-b7ff-e4dac4b6b622", "09d2b5b5-d7c5-4c02-905d-9f84051640f4", "703d6fe5-7f1c-4a9e-8da0-5331f214d5cf", "7d7c2bc5-4b12-4ac3-81a9-630057e9e89f", "645e4195-f63d-4715-a3f2-3fb1e6eb8c70", "556c1ee5-ec38-42e8-955a-1e82dad0ffa1", "ab5a4220-7c42-41e5-a578-eddb9fed3d75", "4edb03c9-8a26-4041-9d01-f85b5d4abd71", "0d34f8e1-46d4-428f-8ddd-4b11811fa7c9", "22a9a7d2-2166-4d86-80ff-22e2643adbcf", "7c3f932b-a572-47cb-9b9b-f20211e63b5b", "581ba6d6-5aac-4492-bebe-54c424a0d46e", "b504f83c-3326-4947-82e1-7fe9e839ec0f", "5bdc3f2a-1be6-4d1c-8e77-992a30824a2c", "dee282d3-891f-4f73-ba02-7f8131e5541b", "1db308ce-c7ad-4d10-96fd-592fa6b75cc4" ], "type": "string", "format": "uuid" }, "title": "Style IDs for Image Models", "default": [ "111dc692-d470-4eec-b791-3475abac4c46" ], "description": "An array of style UUIDs for image models (limited to 1 style)." }, "annotation": { "type": "boolean", "title": "Annotation", "description": "Whether an image reference has marks drawn on it that show what to change" }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" } }, "description": "GPT-Image-2 Model Parameters" } }, "example": { "model": "gpt-image-2", "parameters": { "width": 1024, "height": 1024, "prompt": "your prompt here", "quality": "MEDIUM", "quantity": 4, "style_ids": [ "111dc692-d470-4eec-b791-3475abac4c46" ] } } }, "Openai_gptImage2_5FlareGenerationRequest": { "title": "GPT Image 2.5 Flare", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "openai/gpt-image-2.5-flare" ], "description": "Must be `openai/gpt-image-2.5-flare`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt" ], "properties": { "width": { "type": "integer", "title": "Width", "maximum": 9007199254740991, "minimum": 0, "description": "The width of the image to generate in pixels", "enum": [ 768, 832, 848, 864, 896, 928, 1024, 1088, 1136, 1152, 1184, 1200, 1248, 1264, 1344, 1376, 1536, 1584, 1648, 1696, 1792, 1856, 2016, 2048, 2336, 2448, 2560, 2880, 3200, 3264, 3504, 3584, 3808 ], "default": 1024 }, "height": { "type": "integer", "title": "Height", "maximum": 9007199254740991, "minimum": 0, "description": "The height of the image to generate in pixels", "enum": [ 640, 672, 768, 832, 848, 864, 896, 928, 1024, 1136, 1152, 1184, 1200, 1248, 1264, 1280, 1344, 1376, 1536, 1584, 1632, 1648, 1696, 1792, 1824, 1856, 1920, 2016, 2048, 2336, 2448, 2560, 2880, 3200, 3264, 3504, 3584 ], "default": 1024 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "quality": { "type": "string", "title": "Quality", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Use this instead of `mode` for all third-party models!", "enum": [ "LOW", "MEDIUM", "HIGH", "XHIGH", "MAX" ], "anyOf": [ { "enum": [ "LOW" ] }, { "enum": [ "MEDIUM" ] }, { "enum": [ "HIGH" ] }, { "enum": [ "XHIGH" ] }, { "enum": [ "MAX" ] } ], "default": "HIGH" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 4, "maximum": 8 }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "properties": { "image_reference": { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" } }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 16 } } }, "style_ids": { "type": "array", "items": { "enum": [ "debdf72a-91a4-467b-bf61-cc02bdeb69c6", "3cbb655a-7ca4-463f-b697-8a03ad67327c", "a5632c7c-ddbb-4e2f-ba34-8456ab3ac436", "6fedbf1f-4a17-45ec-84fb-92fe524a29ef", "111dc692-d470-4eec-b791-3475abac4c46", "594c4a08-a522-4e0e-b7ff-e4dac4b6b622", "09d2b5b5-d7c5-4c02-905d-9f84051640f4", "703d6fe5-7f1c-4a9e-8da0-5331f214d5cf", "7d7c2bc5-4b12-4ac3-81a9-630057e9e89f", "645e4195-f63d-4715-a3f2-3fb1e6eb8c70", "556c1ee5-ec38-42e8-955a-1e82dad0ffa1", "ab5a4220-7c42-41e5-a578-eddb9fed3d75", "4edb03c9-8a26-4041-9d01-f85b5d4abd71", "0d34f8e1-46d4-428f-8ddd-4b11811fa7c9", "22a9a7d2-2166-4d86-80ff-22e2643adbcf", "7c3f932b-a572-47cb-9b9b-f20211e63b5b", "581ba6d6-5aac-4492-bebe-54c424a0d46e", "b504f83c-3326-4947-82e1-7fe9e839ec0f", "5bdc3f2a-1be6-4d1c-8e77-992a30824a2c", "dee282d3-891f-4f73-ba02-7f8131e5541b", "1db308ce-c7ad-4d10-96fd-592fa6b75cc4" ], "type": "string", "format": "uuid" }, "title": "Style IDs for Image Models", "default": [ "111dc692-d470-4eec-b791-3475abac4c46" ], "description": "An array of style UUIDs for image models (limited to 1 style)." }, "annotation": { "type": "boolean", "title": "Annotation", "description": "Whether an image reference has marks drawn on it that show what to change" }, "transparency": { "type": "boolean", "title": "Transparency", "description": "Whether the image can be generated with a transparent background" }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" } }, "description": "GPT Image 2.5 Flare Model Parameters" } }, "example": { "model": "openai/gpt-image-2.5-flare", "parameters": { "width": 1024, "height": 1024, "prompt": "your prompt here", "quality": "HIGH", "quantity": 4, "style_ids": [ "111dc692-d470-4eec-b791-3475abac4c46" ] } } }, "Openai_gptImage2_5SunburstGenerationRequest": { "title": "GPT Image 2.5 Sunburst", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "openai/gpt-image-2.5-sunburst" ], "description": "Must be `openai/gpt-image-2.5-sunburst`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt" ], "properties": { "width": { "type": "integer", "title": "Width", "maximum": 9007199254740991, "minimum": 0, "description": "The width of the image to generate in pixels", "enum": [ 768, 832, 848, 864, 896, 928, 1024, 1088, 1136, 1152, 1184, 1200, 1248, 1264, 1344, 1376, 1536, 1584, 1648, 1696, 1792, 1856, 2016, 2048, 2336, 2448, 2560, 2880, 3200, 3264, 3504, 3584, 3808 ], "default": 1024 }, "height": { "type": "integer", "title": "Height", "maximum": 9007199254740991, "minimum": 0, "description": "The height of the image to generate in pixels", "enum": [ 640, 672, 768, 832, 848, 864, 896, 928, 1024, 1136, 1152, 1184, 1200, 1248, 1264, 1280, 1344, 1376, 1536, 1584, 1632, 1648, 1696, 1792, 1824, 1856, 1920, 2016, 2048, 2336, 2448, 2560, 2880, 3200, 3264, 3504, 3584 ], "default": 1024 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "quality": { "type": "string", "title": "Quality", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Use this instead of `mode` for all third-party models!", "enum": [ "LOW", "MEDIUM", "HIGH", "XHIGH", "MAX" ], "anyOf": [ { "enum": [ "LOW" ] }, { "enum": [ "MEDIUM" ] }, { "enum": [ "HIGH" ] }, { "enum": [ "XHIGH" ] }, { "enum": [ "MAX" ] } ], "default": "HIGH" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 4, "maximum": 8 }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "properties": { "image_reference": { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" } }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 16 } } }, "style_ids": { "type": "array", "items": { "enum": [ "debdf72a-91a4-467b-bf61-cc02bdeb69c6", "3cbb655a-7ca4-463f-b697-8a03ad67327c", "a5632c7c-ddbb-4e2f-ba34-8456ab3ac436", "6fedbf1f-4a17-45ec-84fb-92fe524a29ef", "111dc692-d470-4eec-b791-3475abac4c46", "594c4a08-a522-4e0e-b7ff-e4dac4b6b622", "09d2b5b5-d7c5-4c02-905d-9f84051640f4", "703d6fe5-7f1c-4a9e-8da0-5331f214d5cf", "7d7c2bc5-4b12-4ac3-81a9-630057e9e89f", "645e4195-f63d-4715-a3f2-3fb1e6eb8c70", "556c1ee5-ec38-42e8-955a-1e82dad0ffa1", "ab5a4220-7c42-41e5-a578-eddb9fed3d75", "4edb03c9-8a26-4041-9d01-f85b5d4abd71", "0d34f8e1-46d4-428f-8ddd-4b11811fa7c9", "22a9a7d2-2166-4d86-80ff-22e2643adbcf", "7c3f932b-a572-47cb-9b9b-f20211e63b5b", "581ba6d6-5aac-4492-bebe-54c424a0d46e", "b504f83c-3326-4947-82e1-7fe9e839ec0f", "5bdc3f2a-1be6-4d1c-8e77-992a30824a2c", "dee282d3-891f-4f73-ba02-7f8131e5541b", "1db308ce-c7ad-4d10-96fd-592fa6b75cc4" ], "type": "string", "format": "uuid" }, "title": "Style IDs for Image Models", "default": [ "111dc692-d470-4eec-b791-3475abac4c46" ], "description": "An array of style UUIDs for image models (limited to 1 style)." }, "annotation": { "type": "boolean", "title": "Annotation", "description": "Whether an image reference has marks drawn on it that show what to change" }, "transparency": { "type": "boolean", "title": "Transparency", "description": "Whether the image can be generated with a transparent background" }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" } }, "description": "GPT Image 2.5 Sunburst Model Parameters" } }, "example": { "model": "openai/gpt-image-2.5-sunburst", "parameters": { "width": 1024, "height": 1024, "prompt": "your prompt here", "quality": "HIGH", "quantity": 4, "style_ids": [ "111dc692-d470-4eec-b791-3475abac4c46" ] } } }, "RecraftV4GenerationRequest": { "title": "Recraft V4", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "recraft-v4" ], "description": "Must be `recraft-v4`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt" ], "properties": { "width": { "type": "integer", "title": "Width", "maximum": 9007199254740991, "minimum": 0, "description": "The width of the image to generate in pixels", "enum": [ 768, 832, 896, 1024, 1152, 1216, 1280, 1344, 1536 ], "default": 1024 }, "height": { "type": "integer", "title": "Height", "maximum": 9007199254740991, "minimum": 0, "description": "The height of the image to generate in pixels", "enum": [ 768, 832, 896, 1024, 1152, 1216, 1280, 1344, 1536 ], "default": 1024 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 4, "maximum": 8 }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" } }, "description": "Recraft V4 Model Parameters" } }, "example": { "model": "recraft-v4", "parameters": { "width": 1024, "height": 1024, "prompt": "your prompt here", "quantity": 4 } } }, "RecraftV4ProGenerationRequest": { "title": "Recraft V4 Pro", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "recraft-v4-pro" ], "description": "Must be `recraft-v4-pro`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt" ], "properties": { "width": { "type": "integer", "title": "Width", "maximum": 9007199254740991, "minimum": 0, "description": "The width of the image to generate in pixels", "enum": [ 1536, 1664, 1792, 2048, 2304, 2432, 2560, 2688, 3072 ], "default": 2048 }, "height": { "type": "integer", "title": "Height", "maximum": 9007199254740991, "minimum": 0, "description": "The height of the image to generate in pixels", "enum": [ 1536, 1664, 1792, 2048, 2304, 2432, 2560, 2688, 3072 ], "default": 2048 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 4, "maximum": 8 }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" } }, "description": "Recraft V4 Pro Model Parameters" } }, "example": { "model": "recraft-v4-pro", "parameters": { "width": 2048, "height": 2048, "prompt": "your prompt here", "quantity": 4 } } }, "Krea2TurboGenerationRequest": { "title": "Krea 2 Turbo", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "krea-2-turbo" ], "description": "Must be `krea-2-turbo`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt" ], "properties": { "width": { "type": "integer", "title": "Width", "maximum": 4096, "minimum": 16, "description": "The width of the image to generate in pixels", "default": 1024, "multipleOf": 8 }, "height": { "type": "integer", "title": "Height", "maximum": 4096, "minimum": 16, "description": "The height of the image to generate in pixels", "default": 1024, "multipleOf": 8 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 4, "maximum": 8 }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" } }, "description": "Krea 2 Turbo Model Parameters" } }, "example": { "model": "krea-2-turbo", "parameters": { "width": 1024, "height": 1024, "prompt": "your prompt here", "quantity": 4 } } }, "Krea_krea3GenerationRequest": { "title": "Krea 3", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "krea/krea-3" ], "description": "Must be `krea/krea-3`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt" ], "properties": { "seed": { "type": "integer", "title": "Seed", "description": "The seed value for generation", "maximum": 2147483647, "minimum": 0 }, "width": { "type": "integer", "title": "Width", "maximum": 3200, "minimum": 256, "description": "The width of the image to generate in pixels", "default": 1024, "multipleOf": 16 }, "height": { "type": "integer", "title": "Height", "maximum": 3200, "minimum": 256, "description": "The height of the image to generate in pixels", "default": 1024, "multipleOf": 16 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 5000, "minLength": 1, "description": "The prompt to use for the generation" }, "quality": { "type": "string", "title": "Quality", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "How much the model plans the image before it generates it. HIGH needs at least one image reference and costs more.", "enum": [ "LOW", "MEDIUM", "HIGH" ], "anyOf": [ { "enum": [ "LOW" ] }, { "enum": [ "MEDIUM" ] }, { "enum": [ "HIGH" ] } ], "default": "MEDIUM" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 4, "maximum": 8 }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "properties": { "image_reference": { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" } }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 8 } } }, "thinking_mode": { "enum": [ "slow", "fast" ], "type": "string", "default": "fast", "description": "slow gives the most detailed images. fast generates faster." } }, "description": "Krea 3 Model Parameters" } }, "example": { "model": "krea/krea-3", "parameters": { "width": 1024, "height": 1024, "prompt": "your prompt here", "quality": "MEDIUM", "quantity": 4, "thinking_mode": "fast" } } }, "Krea_krea2GenerationRequest": { "title": "Krea 2", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "krea/krea-2" ], "description": "Must be `krea/krea-2`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt" ], "properties": { "seed": { "type": "integer", "title": "Seed", "description": "The seed value for generation", "maximum": 4294967295, "minimum": 0 }, "width": { "type": "integer", "title": "Width", "maximum": 4096, "minimum": 16, "description": "The width of the image to generate in pixels", "default": 1024, "multipleOf": 8 }, "height": { "type": "integer", "title": "Height", "maximum": 4096, "minimum": 16, "description": "The height of the image to generate in pixels", "default": 1024, "multipleOf": 8 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 5000, "minLength": 1, "description": "The prompt to use for the generation" }, "quality": { "type": "string", "title": "Quality", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Use this instead of `mode` for all third-party models!", "enum": [ "MEDIUM", "HIGH" ], "anyOf": [ { "enum": [ "MEDIUM" ] }, { "enum": [ "HIGH" ] } ], "default": "MEDIUM" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 4, "maximum": 8 }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "properties": { "style": { "type": "array", "items": { "type": "object", "title": "Style reference", "required": [ "image", "strength" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" }, "strength": { "enum": [ "LOW", "MID", "HIGH", "ULTRA", "MAX" ], "type": "string", "default": "MID", "description": "The strength of the guidance" } }, "description": "Style transfer guidance object, containing parameters available for style transfer image guidance" }, "title": "Style Reference", "description": "References the style from the input image to guide your image generation.", "maxItems": 10 } } }, "prompt_enhance": { "enum": [ "AUTO", "ON", "OFF" ], "type": "string", "title": "Prompt Enhance", "default": "AUTO", "description": "Whether to enhance the prompt or not" } }, "description": "Krea 2 Model Parameters" } }, "example": { "model": "krea/krea-2", "parameters": { "width": 1024, "height": 1024, "prompt": "your prompt here", "quality": "MEDIUM", "quantity": 4 } } }, "KlingVideoO1GenerationRequest": { "title": "Kling O1 Video Model", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "kling-video-o-1" ], "description": "Must be `kling-video-o-1`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ {}, {}, {}, {} ], "required": [ "prompt" ], "properties": { "mode": { "type": "string", "title": "Quality", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Deprecated. Width and height are the canonical inputs for this model. This field is retained for backwards compatibility with mobile clients and Production API consumers that still send `mode`. Validation is silent: omitted is the new norm; explicit values are still consistency-checked against width and height.", "enum": [ "RESOLUTION_1080" ], "default": "RESOLUTION_1080", "deprecated": true }, "width": { "type": "integer", "default": 1920, "maximum": 2160, "minimum": 0 }, "height": { "type": "integer", "default": 1080, "maximum": 2160, "minimum": 0 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 2500, "minLength": 1, "description": "The prompt to use for the generation" }, "duration": { "type": "integer", "title": "Duration", "description": "Duration of the video in seconds", "default": 5, "maximum": 10, "minimum": 3 }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 1 }, "guidances": { "type": "object", "properties": { "end_frame": { "type": "array", "items": { "type": "object", "title": "End Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "End Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 }, "start_frame": { "type": "array", "items": { "type": "object", "title": "Start Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "Start Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 }, "image_reference": { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" } }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 5 }, "video_reference_base": { "type": "array", "allOf": [ { "type": "array", "items": { "type": "object", "title": "Video Reference Base", "required": [ "video" ], "properties": { "video": { "type": "object", "title": "Video reference", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Video URL (enriched by backend when video is resolved" }, "type": { "enum": [ "UPLOADED", "GENERATED" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" }, "duration": { "type": "number" }, "motion_has_audio": { "type": "boolean" } }, "description": "A reference to a video", "additionalProperties": false } } }, "title": "Video Reference Base", "description": "Base video to be edited." }, { "items": { "type": "object", "properties": { "video": { "type": "object", "properties": { "width": { "type": "integer", "maximum": 2160, "minimum": 720 }, "height": { "type": "integer", "maximum": 2160, "minimum": 720 }, "duration": { "type": "number", "maximum": 10.05, "minimum": 3 } } } } } } ], "maxItems": 1, "properties": { "0": { "type": "object", "properties": { "video": { "type": "object", "properties": { "duration": {} } } } } } } }, "additionalProperties": false } } } }, "example": { "model": "kling-video-o-1", "parameters": { "width": 1920, "height": 1080, "prompt": "your prompt here", "duration": 5, "quantity": 1 } } }, "Kling3_0GenerationRequest": { "title": "Kling Video 3.0", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "kling-3.0" ], "description": "Must be `kling-3.0`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ {}, {}, {} ], "oneOf": [ { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1920 ] }, "height": { "enum": [ 1080 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1080 ] }, "height": { "enum": [ 1920 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1440 ] }, "height": { "enum": [ 1440 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1280 ] }, "height": { "enum": [ 720 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 720 ] }, "height": { "enum": [ 1280 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 960 ] }, "height": { "enum": [ 960 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 0 ] }, "height": { "enum": [ 0 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 3840 ] }, "height": { "enum": [ 2160 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 2160 ] }, "height": { "enum": [ 3840 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 2880 ] }, "height": { "enum": [ 2880 ] } } }, { "not": { "anyOf": [ { "required": [ "width" ] }, { "required": [ "height" ] } ] } } ], "required": [ "prompt" ], "properties": { "mode": { "type": "string", "title": "Quality", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Deprecated. Width and height are the canonical inputs for this model. This field is retained for backwards compatibility with mobile clients and Production API consumers that still send `mode`. Validation is silent: omitted is the new norm; explicit values are still consistency-checked against width and height.", "enum": [ "RESOLUTION_720", "RESOLUTION_1080", "RESOLUTION_2160" ], "anyOf": [ { "enum": [ "RESOLUTION_720" ] }, { "enum": [ "RESOLUTION_1080" ] }, { "enum": [ "RESOLUTION_2160" ] } ], "default": "RESOLUTION_1080", "deprecated": true }, "width": { "enum": [ 1920, 1080, 1440, 1280, 720, 960, 0, 3840, 2160, 2880 ], "type": "integer" }, "height": { "enum": [ 1080, 1920, 1440, 720, 1280, 960, 0, 2160, 3840, 2880 ], "type": "integer" }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 2500, "minLength": 1, "description": "The prompt to use for the generation" }, "duration": { "type": "integer", "title": "Duration", "description": "Duration of the video in seconds", "enum": [ 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ], "default": 5 }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 1 }, "guidances": { "type": "object", "properties": { "end_frame": { "type": "array", "items": { "type": "object", "title": "End Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "End Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 }, "start_frame": { "type": "array", "items": { "type": "object", "title": "Start Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "Start Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 } }, "additionalProperties": false }, "motion_has_audio": { "type": "boolean", "title": "Audio", "default": true, "description": "Whether the video generation will include audio." } }, "description": "Architecture properties of the Kling Video 3.0 model" } }, "example": { "model": "kling-3.0", "parameters": { "prompt": "your prompt here", "duration": 5, "quantity": 1, "motion_has_audio": true } } }, "Kling3_0TurboGenerationRequest": { "title": "Kling 3.0 Turbo", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "kling-3.0-turbo" ], "description": "Must be `kling-3.0-turbo`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ {} ], "oneOf": [ { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1920 ] }, "height": { "enum": [ 1080 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1080 ] }, "height": { "enum": [ 1920 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1440 ] }, "height": { "enum": [ 1440 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1280 ] }, "height": { "enum": [ 720 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 720 ] }, "height": { "enum": [ 1280 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 960 ] }, "height": { "enum": [ 960 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 0 ] }, "height": { "enum": [ 0 ] } } }, { "not": { "anyOf": [ { "required": [ "width" ] }, { "required": [ "height" ] } ] } } ], "required": [ "prompt" ], "properties": { "width": { "enum": [ 1920, 1080, 1440, 1280, 720, 960, 0 ], "type": "integer" }, "height": { "enum": [ 1080, 1920, 1440, 720, 1280, 960, 0 ], "type": "integer" }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 2500, "minLength": 1, "description": "The prompt to use for the generation" }, "duration": { "type": "integer", "title": "Duration", "description": "Duration of the video in seconds", "enum": [ 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ], "default": 5 }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 1 }, "guidances": { "type": "object", "properties": { "start_frame": { "type": "array", "items": { "type": "object", "title": "Start Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "Start Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 } }, "additionalProperties": false }, "motion_has_audio": { "type": "boolean", "title": "Audio", "default": true, "description": "Whether the video generation will include audio." } }, "description": "Architecture properties of the Kling 3.0 Turbo model" } }, "example": { "model": "kling-3.0-turbo", "parameters": { "prompt": "your prompt here", "duration": 5, "quantity": 1 } } }, "GeminiOmniFlashGenerationRequest": { "title": "Gemini Omni Flash", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "gemini-omni-flash" ], "description": "Must be `gemini-omni-flash`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "oneOf": [ { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1280 ] }, "height": { "enum": [ 720 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 720 ] }, "height": { "enum": [ 1280 ] } } }, { "not": { "anyOf": [ { "required": [ "width" ] }, { "required": [ "height" ] } ] } } ], "required": [ "prompt" ], "properties": { "width": { "enum": [ 1280, 720 ], "type": "integer" }, "height": { "enum": [ 720, 1280 ], "type": "integer" }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 2500, "minLength": 1, "description": "The prompt to use for the generation" }, "duration": { "type": "integer", "title": "Duration", "description": "Duration of the video in seconds", "enum": [ 3, 4, 5, 6, 7, 8, 9, 10 ], "default": 5 }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 1 }, "guidances": { "type": "object", "properties": { "image_reference": { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" } }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 5 } }, "additionalProperties": false } }, "description": "Architecture properties of the Gemini Omni Flash model" } }, "example": { "model": "gemini-omni-flash", "parameters": { "prompt": "your prompt here", "duration": 5, "quantity": 1 } } }, "Google_geminiOmni1_1FlashPreviewGenerationRequest": { "title": "Gemini Omni 1.1 Flash", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "google/gemini-omni-1.1-flash-preview" ], "description": "Must be `google/gemini-omni-1.1-flash-preview`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ {}, {}, {} ], "oneOf": [ { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 640 ] }, "height": { "enum": [ 360 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 360 ] }, "height": { "enum": [ 640 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1280 ] }, "height": { "enum": [ 720 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 720 ] }, "height": { "enum": [ 1280 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1920 ] }, "height": { "enum": [ 1080 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1080 ] }, "height": { "enum": [ 1920 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 3840 ] }, "height": { "enum": [ 2160 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 2160 ] }, "height": { "enum": [ 3840 ] } } }, { "not": { "anyOf": [ { "required": [ "width" ] }, { "required": [ "height" ] } ] } } ], "required": [ "prompt" ], "properties": { "width": { "enum": [ 3840, 2160, 1920, 1280, 1080, 720, 640, 360 ], "type": "integer" }, "height": { "enum": [ 3840, 2160, 1920, 1280, 1080, 720, 640, 360 ], "type": "integer" }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 2500, "minLength": 1, "description": "The prompt to use for the generation" }, "duration": { "type": "integer", "title": "Duration", "description": "Duration of the video in seconds", "enum": [ 3, 4, 5, 6, 7, 8, 9, 10 ], "default": 5 }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 1 }, "guidances": { "type": "object", "properties": { "end_frame": { "type": "array", "items": { "type": "object", "title": "End Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "End Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 }, "start_frame": { "type": "array", "items": { "type": "object", "title": "Start Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "Start Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 }, "image_reference": { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" } }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 10 }, "video_reference_base": { "type": "array", "allOf": [ { "type": "array", "items": { "type": "object", "title": "Video Reference Base", "required": [ "video" ], "properties": { "video": { "type": "object", "title": "Video reference", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Video URL (enriched by backend when video is resolved" }, "type": { "enum": [ "UPLOADED", "GENERATED" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" }, "duration": { "type": "number" }, "motion_has_audio": { "type": "boolean" } }, "description": "A reference to a video", "additionalProperties": false } } }, "title": "Video Reference Base", "description": "Base video to be edited." }, { "items": { "type": "object", "properties": { "video": { "type": "object", "required": [ "duration" ], "properties": { "duration": { "type": "number", "maximum": 10 } } } } } } ], "maxItems": 3 } }, "additionalProperties": false }, "motion_has_audio": { "type": "boolean", "title": "Audio", "default": true, "description": "Whether the video generation will include audio." } }, "description": "Architecture properties of the Gemini Omni 1.1 Flash model" } }, "example": { "model": "google/gemini-omni-1.1-flash-preview", "parameters": { "prompt": "your prompt here", "duration": 5, "quantity": 1 } } }, "KlingVideoO3GenerationRequest": { "title": "Kling Video O3 Omni", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "kling-video-o-3" ], "description": "Must be `kling-video-o-3`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ {}, {}, {}, {}, {}, {}, {}, {} ], "required": [ "prompt" ], "properties": { "mode": { "type": "string", "title": "Quality", "pattern": "^[A-Z][A-Z0-9_]*[A-Z0-9]$", "description": "Deprecated. Width and height are the canonical inputs for this model. This field is retained for backwards compatibility with mobile clients and Production API consumers that still send `mode`. Validation is silent: omitted is the new norm; explicit values are still consistency-checked against width and height.", "enum": [ "RESOLUTION_720", "RESOLUTION_1080", "RESOLUTION_2160" ], "anyOf": [ { "enum": [ "RESOLUTION_720" ] }, { "enum": [ "RESOLUTION_1080" ] }, { "enum": [ "RESOLUTION_2160" ] } ], "default": "RESOLUTION_1080", "deprecated": true }, "width": { "type": "integer", "default": 1920, "maximum": 3840, "minimum": 0 }, "height": { "type": "integer", "default": 1080, "maximum": 3840, "minimum": 0 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 2500, "minLength": 1, "description": "The prompt to use for the generation" }, "duration": { "type": "integer", "title": "Duration", "description": "Duration of the video in seconds", "enum": [ 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ], "default": 5 }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 1 }, "guidances": { "type": "object", "properties": { "end_frame": { "type": "array", "items": { "type": "object", "title": "End Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "End Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 }, "start_frame": { "type": "array", "items": { "type": "object", "title": "Start Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "Start Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 }, "image_reference": { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" } }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 7 }, "video_reference_base": { "type": "array", "allOf": [ { "type": "array", "items": { "type": "object", "title": "Video Reference Base", "required": [ "video" ], "properties": { "video": { "type": "object", "title": "Video reference", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Video URL (enriched by backend when video is resolved" }, "type": { "enum": [ "UPLOADED", "GENERATED" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" }, "duration": { "type": "number" }, "motion_has_audio": { "type": "boolean" } }, "description": "A reference to a video", "additionalProperties": false } } }, "title": "Video Reference Base", "description": "Base video to be edited." }, { "items": { "type": "object", "properties": { "video": { "type": "object", "properties": { "width": { "type": "integer", "maximum": 2160, "minimum": 720 }, "height": { "type": "integer", "maximum": 2160, "minimum": 720 }, "duration": { "type": "number", "maximum": 10.05, "minimum": 3 } } } } } } ], "maxItems": 1, "properties": { "0": { "type": "object", "properties": { "video": { "type": "object", "properties": { "duration": {} } } } } } } }, "additionalProperties": false }, "motion_has_audio": { "type": "boolean", "title": "Audio", "default": true, "description": "Whether the video generation will include audio." } }, "description": "Architecture properties of the Kling Video o3 Omni model" } }, "example": { "model": "kling-video-o-3", "parameters": { "width": 1920, "height": 1080, "prompt": "your prompt here", "duration": 5, "quantity": 1, "motion_has_audio": true } } }, "Kling4_0GenerationRequest": { "title": "Kling 4.0", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "kling-4.0" ], "description": "Must be `kling-4.0`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "allOf": [ {}, {} ], "oneOf": [ { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1470 ] }, "height": { "enum": [ 630 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 2520 ] }, "height": { "enum": [ 1080 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1280 ] }, "height": { "enum": [ 720 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1920 ] }, "height": { "enum": [ 1080 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 960 ] }, "height": { "enum": [ 960 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1440 ] }, "height": { "enum": [ 1440 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 720 ] }, "height": { "enum": [ 1280 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 1080 ] }, "height": { "enum": [ 1920 ] } } }, { "required": [ "width", "height" ], "properties": { "width": { "enum": [ 0 ] }, "height": { "enum": [ 0 ] } } }, { "not": { "anyOf": [ { "required": [ "width" ] }, { "required": [ "height" ] } ] } } ], "required": [ "prompt" ], "properties": { "width": { "enum": [ 720, 960, 1080, 1280, 1440, 1470, 1920, 2520, 0 ], "type": "integer", "default": 1280 }, "height": { "enum": [ 630, 720, 960, 1080, 1280, 1440, 1920, 0 ], "type": "integer", "default": 720 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 2500, "minLength": 1, "description": "The prompt to use for the generation" }, "duration": { "type": "integer", "title": "Duration", "description": "Duration of the video in seconds", "enum": [ 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30 ], "default": 5 }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 1 }, "guidances": { "type": "object", "properties": { "end_frame": { "type": "array", "items": { "type": "object", "title": "End Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "End Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 }, "start_frame": { "type": "array", "items": { "type": "object", "title": "Start Frame", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" } } }, "title": "Start Frame", "description": "Creative reinterpretation of vibe or structure from a reference image.", "uniqueItems": true, "maxItems": 1 }, "image_reference": { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" } }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 10 }, "video_reference_base": { "type": "array", "allOf": [ { "type": "array", "items": { "type": "object", "title": "Video Reference Base", "required": [ "video" ], "properties": { "video": { "type": "object", "title": "Video reference", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Video URL (enriched by backend when video is resolved" }, "type": { "enum": [ "UPLOADED", "GENERATED" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" }, "duration": { "type": "number" }, "motion_has_audio": { "type": "boolean" } }, "description": "A reference to a video", "additionalProperties": false } } }, "title": "Video Reference Base", "description": "Base video to be edited." }, { "items": { "type": "object", "properties": { "video": { "type": "object", "properties": { "width": { "type": "integer", "maximum": 4553, "minimum": 700 }, "height": { "type": "integer", "maximum": 4553, "minimum": 700 }, "duration": { "type": "number", "maximum": 30.05, "minimum": 3 } } } } } } ], "maxItems": 1, "properties": { "0": { "type": "object", "properties": { "video": { "type": "object", "properties": { "duration": {} } } } } } } }, "additionalProperties": false }, "motion_has_audio": { "type": "boolean", "title": "Audio", "default": true, "description": "Whether the video generation will include audio." } }, "description": "Architecture properties of the Kling 4.0 model" } }, "example": { "model": "kling-4.0", "parameters": { "width": 1280, "height": 720, "prompt": "your prompt here", "duration": 5 } } }, "AuroraUpscalerCreativeGenerationRequest": { "title": "Aurora Upscaler Creative", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "aurora-upscaler-creative" ], "description": "Must be `aurora-upscaler-creative`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "guidances", "width", "height" ], "properties": { "seed": { "type": "integer", "title": "Seed", "description": "The seed value for generation", "maximum": 2147483647, "minimum": 0 }, "width": { "type": "integer", "minimum": 128, "description": "Width of the input image in pixels" }, "height": { "type": "integer", "minimum": 128, "description": "Height of the input image in pixels" }, "priority": { "type": "integer", "description": "Priority level for job queue routing" }, "quantity": { "type": "integer", "default": 1, "maximum": 1, "minimum": 1, "description": "Number of upscaled images to generate (fixed at 1)" }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "required": [ "image_reference" ], "properties": { "image_reference": { "type": "array", "items": {}, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 1, "minItems": 1 } } }, "creativity": { "enum": [ "low", "mid", "high" ], "type": "string", "oneOf": [ { "enum": [ "low" ] }, { "enum": [ "mid" ] }, { "enum": [ "high" ] } ], "default": "mid", "description": "Creativity level affecting guidance and denoise strength" }, "upscale_factor": { "enum": [ 2, 3, 4, 6, 8 ], "type": "number", "oneOf": [ { "enum": [ 2 ] }, { "enum": [ 3 ] }, { "enum": [ 4 ] }, { "enum": [ 6 ] }, { "enum": [ 8 ] } ], "default": 2, "description": "Upscaling multiplier from 2.0x to 8.0x" } }, "description": "Aurora Upscaler Creative Parameters" } }, "example": { "model": "aurora-upscaler-creative", "parameters": { "width": 128, "height": 128, "quantity": 1, "guidances": "your guidances here", "creativity": "mid", "upscale_factor": 2 } } }, "AuroraUpscalerPreciseGenerationRequest": { "title": "Aurora Upscaler Precise", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "aurora-upscaler-precise" ], "description": "Must be `aurora-upscaler-precise`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "guidances", "width", "height" ], "properties": { "seed": { "type": "integer", "title": "Seed", "description": "The seed value for generation", "maximum": 2147483647, "minimum": 0 }, "width": { "type": "integer", "minimum": 128, "description": "Width of the input image in pixels" }, "height": { "type": "integer", "minimum": 128, "description": "Height of the input image in pixels" }, "priority": { "type": "integer", "description": "Priority level for job queue routing" }, "quantity": { "type": "integer", "default": 1, "maximum": 1, "minimum": 1, "description": "Number of upscaled images to generate (fixed at 1)" }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "required": [ "image_reference" ], "properties": { "image_reference": { "type": "array", "items": {}, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 1, "minItems": 1 } } }, "upscale_mode": { "type": "string", "oneOf": [ { "enum": [ "clean" ] }, { "enum": [ "detailed" ] } ], "default": "detailed", "description": "Runs a pre-processing step to minimise noise and visual artifacts that may otherwise be amplified during enlargement." }, "upscale_factor": { "enum": [ 2, 3, 4, 6, 8 ], "type": "number", "oneOf": [ { "enum": [ 2 ] }, { "enum": [ 3 ] }, { "enum": [ 4 ] }, { "enum": [ 6 ] }, { "enum": [ 8 ] } ], "default": 2, "description": "Upscaling factor from 2.0x to 8.0x" } }, "description": "Aurora Upscaler Precise Parameters" } }, "example": { "model": "aurora-upscaler-precise", "parameters": { "width": 128, "height": 128, "quantity": 1, "guidances": "your guidances here", "upscale_mode": "detailed", "upscale_factor": 2 } } }, "RemoveBgGenerationRequest": { "title": "Remove Background", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "remove-bg" ], "description": "Must be `remove-bg`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "guidances" ], "properties": { "roi": { "type": "string", "description": "Region of interest to search for the subject, given as two x/y coordinate pairs in pixels ('0px 0px 100px 100px') or percentages ('0% 0% 100% 100%'). Anything outside this rectangle is treated as background." }, "crop": { "type": "boolean", "default": false, "description": "Crops the output image to the bounding box of the subject." }, "size": { "enum": [ "auto", "preview", "full", "50MP" ], "type": "string", "anyOf": [ { "enum": [ "preview" ] }, { "enum": [ "auto" ] }, { "enum": [ "full" ] }, { "enum": [ "50MP" ] } ], "default": "full", "description": "Maximum output image resolution. 'preview' caps at 0.25 megapixels, 'full' and 'auto' cap at 25 megapixels, and '50MP' allows up to 50 megapixels. PNG output is capped at 10 megapixels regardless of this setting." }, "type": { "enum": [ "auto", "person", "product", "car", "animal", "graphic", "transportation", "other" ], "type": "string", "default": "auto", "description": "Foreground type hint to improve cutout quality." }, "scale": { "type": "string", "description": "Scale of the subject relative to the output canvas, as 'original' or a percentage between '10%' and '100%'." }, "format": { "enum": [ "png", "jpg", "webp" ], "type": "string", "default": "png", "description": "Output image format. PNG and WebP preserve transparency, JPG does not. PNG is capped at 10 megapixels by the provider, so pair larger 'size' values with WebP to keep transparency. remove.bg's 'auto' is deliberately not offered: it picks PNG or JPG from the finished pixels, and the output's storage key has to be named before the request is sent." }, "bg_color": { "type": "string", "description": "Adds a solid background color to the cutout (hex code or color name). Output is no longer transparent — pair with 'jpg' when possible." }, "channels": { "enum": [ "rgba", "alpha" ], "type": "string", "default": "rgba", "description": "'rgba' returns the cutout image; 'alpha' returns only the greyscale alpha mask." }, "position": { "type": "string", "description": "Position of the subject within the output canvas, as 'original', 'center', a single percentage, or two percentages for horizontal and vertical placement." }, "quantity": { "type": "integer", "default": 1, "maximum": 1, "minimum": 1, "description": "Number of outputs to generate (fixed at 1)" }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "required": [ "image_reference" ], "properties": { "image_reference": { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" } }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 1, "minItems": 1 }, "background_image_reference": { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": {} }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "maxItems": 1, "minItems": 1, "description": "An image to composite behind the cutout. Accepts a Leonardo image id, a URL, or base64 image bytes. Omit this field to keep the background transparent, or set bg_color for a solid fill." } } }, "type_level": { "enum": [ "none", "1", "2", "latest" ], "type": "string", "description": "How specifically the subject should be classified. 'none' skips classification, '1' picks a coarse category, '2' picks a specific category, and 'latest' uses the most detailed classification available." }, "crop_margin": { "type": "string", "description": "Margin to add around the cropped subject, as an absolute value ('30px') or relative to the subject size ('10%'). Accepts one, two, or four values and only applies when 'crop' is enabled." }, "shadow_type": { "enum": [ "none", "drop", "3d", "car" ], "type": "string", "default": "none", "description": "Style of artificial shadow to render under the subject." }, "shadow_opacity": { "type": "integer", "maximum": 100, "minimum": 0, "description": "Opacity of the artificial shadow, from 0 to 100. Only applies when a shadow is enabled." }, "semitransparency": { "type": "boolean", "default": true, "description": "Preserves semi-transparent regions such as glass, smoke, and veils." } }, "description": "Architecture properties of the Remove Background model", "additionalProperties": false } }, "example": { "model": "remove-bg", "parameters": { "size": "full", "channels": "rgba", "quantity": 1, "guidances": "your guidances here", "shadow_type": "none", "semitransparency": true } } }, "RodinV2GenerationRequest": { "title": "Rodin V2", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "rodin-v2" ], "description": "Must be `rodin-v2`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "guidances", "quantity", "output_format" ], "properties": { "seed": { "type": "integer", "maximum": 65535, "minimum": 0, "description": "Seed for reproducible generation" }, "quality": { "enum": [ "extra_low", "low", "medium", "high" ], "type": "string", "default": "high", "description": "Generation quality level. Polygon counts depend on mesh_mode: Triangle (extra_low: 2k, low: 20k, medium: 150k, high: 500k); Quad (extra_low: 4k, low: 8k, medium: 18k, high: 50k)" }, "ta_pose": { "type": "boolean", "default": false, "description": "Apply T/A-pose constraint for human character meshes (easier to rig and animate)" }, "material": { "enum": [ "PBR", "Shaded", "All" ], "type": "string", "default": "All", "description": "Material mode for the generated mesh" }, "quantity": { "type": "integer", "enum": [ 1 ] }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "required": [ "image_reference" ], "properties": { "image_reference": { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" } }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 5, "minItems": 1 } }, "additionalProperties": false }, "mesh_mode": { "enum": [ "Quad", "Triangle" ], "type": "string", "default": "Triangle", "description": "Type of faces in the generated mesh. Quad produces quadrilateral faces (smoother surfaces), Triangle produces triangular faces (more detailed geometry)" }, "bounding_box": { "type": "array", "items": { "type": "integer" }, "maxItems": 3, "minItems": 3, "description": "Bounding box dimensions as [width, height, length] integers to constrain the generated model size" }, "output_format": { "type": "string", "enum": [ "glb" ], "title": "Output format", "description": "Mesh file format for the generated 3D asset (GLB only for now)." }, "use_original_alpha": { "type": "boolean", "default": false, "description": "Preserve original alpha channel from input images" } }, "description": "Rodin V2 Model Parameters", "additionalProperties": false } }, "example": { "model": "rodin-v2", "parameters": { "quality": "high", "ta_pose": false, "material": "All", "quantity": 1, "guidances": "your guidances here", "mesh_mode": "Triangle", "output_format": "your output_format here", "use_original_alpha": false } } }, "Meshy_meshy7GenerationRequest": { "title": "Meshy 7", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "meshy/meshy-7" ], "description": "Must be `meshy/meshy-7`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "properties": { "prompt": { "type": "string", "title": "Prompt", "maxLength": 600, "description": "Describes the object to generate. Required without image references. With image references it guides the texturing." }, "quantity": { "type": "integer", "enum": [ 1 ], "default": 1 }, "topology": { "enum": [ "quad", "triangle" ], "type": "string", "default": "triangle", "description": "Type of faces in the generated mesh. Quad produces quadrilateral faces (smoother surfaces), Triangle produces triangular faces (more detailed geometry)" }, "guidances": { "type": "object", "title": "Image guidance", "description": "The image guidance properties object that will be defined on a per-model basis.", "properties": { "image_reference": { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" } }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "title": "Image Reference", "description": "References images to guide your video generation.", "maxItems": 4 } }, "additionalProperties": false }, "pose_mode": { "enum": [ "none", "a-pose", "t-pose" ], "type": "string", "default": "none", "description": "Pose constraint for character meshes. A-pose and T-pose make the mesh easier to rig and animate." }, "enable_pbr": { "type": "boolean", "default": false, "description": "Adds metallic, roughness and normal maps for physically based rendering. Applies only when should_texture is true." }, "output_format": { "type": "string", "enum": [ "glb" ], "title": "Output format", "default": "glb", "description": "Mesh file format for the generated 3D asset (GLB only for now)." }, "symmetry_mode": { "enum": [ "auto", "on", "off" ], "type": "string", "default": "auto", "description": "Symmetry of the generated mesh. Auto decides from the input, On enforces symmetry, Off disables it." }, "enable_rigging": { "type": "boolean", "anyOf": [ { "enum": [ true ] }, { "enum": [ false ] } ], "default": false, "description": "Adds a humanoid skeleton to the mesh so that it can be animated. Works best with humanoid characters that have clearly defined limbs." }, "should_texture": { "type": "boolean", "anyOf": [ { "enum": [ true ] }, { "enum": [ false ] } ], "default": true, "description": "Adds a base color texture to the generated mesh. Without a texture the mesh is untextured geometry." }, "enable_animation": { "type": "boolean", "default": false, "description": "Applies an animation from the Meshy animation library to the rigged character. Requires enable_rigging." }, "target_polycount": { "type": "integer", "default": 30000, "maximum": 300000, "minimum": 1000, "multipleOf": 1000, "description": "Target number of polygons in the generated mesh." }, "animation_action_id": { "type": "integer", "default": 92, "maximum": 696, "minimum": 0, "description": "ID of the animation in the Meshy animation library (https://docs.meshy.ai/en/api/animation-library). 0 is Idle. Applies only when enable_animation is true." }, "geometry_resolution": { "enum": [ "standard", "2k" ], "type": "string", "anyOf": [ { "enum": [ "standard" ] }, { "enum": [ "2k" ] } ], "default": "standard", "description": "Geometry detail level. 2k captures finer surface detail." }, "rigging_height_meters": { "type": "number", "default": 1.7, "minimum": 0.1, "description": "Approximate height of the character in meters. Scales the skeleton that rigging adds. Applies only when enable_rigging is true." } }, "description": "Meshy 7 Model Parameters", "additionalProperties": false } }, "example": { "model": "meshy/meshy-7", "parameters": { "topology": "triangle", "pose_mode": "none", "enable_pbr": false, "symmetry_mode": "auto", "enable_rigging": false, "should_texture": true, "enable_animation": false, "target_polycount": 30000, "animation_action_id": 92, "geometry_resolution": "standard", "rigging_height_meters": 1.7 } } }, "MusicV1GenerationRequest": { "title": "Music", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "music-v1" ], "description": "Must be `music-v1`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt" ], "properties": { "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 4 }, "duration_minutes": { "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ], "type": "integer", "default": 1, "description": "Duration of the generated track in whole minutes (1-10)." }, "force_instrumental": { "type": "boolean", "default": false, "description": "When true, guarantees an instrumental-only output (no vocals)." } }, "description": "Music v1 Model Parameters", "additionalProperties": false } }, "example": { "model": "music-v1", "parameters": { "prompt": "your prompt here", "quantity": 1, "duration_minutes": 1, "force_instrumental": false } } }, "SoundEffectsV2GenerationRequest": { "title": "Sound Effects", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "sound-effects-v2" ], "description": "Must be `sound-effects-v2`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt" ], "properties": { "loop": { "type": "boolean", "default": false }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 9999, "minLength": 1, "description": "The prompt to use for the generation" }, "duration": { "type": "integer", "title": "Duration", "description": "Duration of the video in seconds", "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22 ], "default": 2, "maximum": 22, "minimum": 1 }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 4 }, "prompt_influence": { "type": "number", "default": 0.7, "maximum": 1, "minimum": 0 } }, "description": "Sound Effects v2 Model Parameters", "additionalProperties": false } }, "example": { "model": "sound-effects-v2", "parameters": { "loop": false, "prompt": "your prompt here", "duration": 2, "quantity": 1, "prompt_influence": 0.7 } } }, "DialogueV3GenerationRequest": { "title": "Dialogue", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "dialogue-v3" ], "description": "Must be `dialogue-v3`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt" ], "properties": { "prompt": { "type": "string", "title": "Prompt", "maxLength": 5000, "minLength": 1, "description": "The script to speak. The model speaks every word aloud. Write only the words to say. Do not add stage directions, speaker labels, or descriptions of the voice, tone, pace, or style, because the model speaks them too. To direct the delivery, put an audio tag in square brackets immediately before or after the words it changes, for example [whispers], [sighs], [laughs], [excited], or [sarcastic]. The model performs a tag and does not speak it. Write \"[whispers] Come closer.\", not \"Whispering softly: Come closer.\" Use ellipses (...) for pauses and capital letters for emphasis. Do not use SSML break tags. Choose a voice_id that suits the delivery, because a tag cannot make a calm voice shout. A lower prompt_influence makes the voice respond more to tags." }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 4 }, "voice_id": { "enum": [ "CwhRBWXzGAHq8TQ4Fs17", "EXAVITQu4vr4xnSDxMaL", "FGY2WhTYpPnrIDTdsKH5", "IKne3meq5aSn9XLyUdCD", "JBFqnCBsd6RMkjVDRZzb", "N2lVS1w4EtoT3dr4eOWO", "SAz9YHcvj6GT2YYXdXww", "SOYHLrjzK2X1ezoPC6cr", "TX3LPaxmHKxFdv7VOQHJ", "Xb7hH8MSUJpSbSDYk0k2", "XrExE9yKIg1WjnnlVkGX", "bIHbv24MWmeRgasZH58o", "cgSgspJ2msm6clMCkdW9", "cjVigY5qzO86Huf0OWal", "hpp4J3VqNfWAUOO0d1Us", "iP95p4xoKVk53GoZ742B", "nPczCjzI2devNBz1zQrb", "onwK4e9ZLuTAKqWW03F9", "pFZP5JQG7iQjIQuC4Bku", "pNInz6obpgDQGcFmaJgB", "pqHfZKP75CvOlQylNhV4" ], "type": "string", "default": "JBFqnCBsd6RMkjVDRZzb" }, "language_code": { "type": "string", "default": "en" }, "prompt_influence": { "type": "number", "default": 0.5, "maximum": 1, "minimum": 0 } }, "description": "Dialogue v3 Model Parameters", "additionalProperties": false } }, "example": { "model": "dialogue-v3", "parameters": { "prompt": "your prompt here", "quantity": 1, "voice_id": "JBFqnCBsd6RMkjVDRZzb", "prompt_influence": 0.5 } } }, "SeedAudio1_0GenerationRequest": { "title": "Seed Audio 1.0", "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "enum": [ "seed-audio-1.0" ], "description": "Must be `seed-audio-1.0`." }, "public": { "type": "boolean", "description": "Whether the generated images should show in the community feed." }, "parameters": { "type": "object", "required": [ "prompt" ], "properties": { "pitch": { "type": "integer", "default": 0, "maximum": 12, "minimum": -12 }, "speed": { "type": "number", "default": 1, "maximum": 2, "minimum": 0.5 }, "prompt": { "type": "string", "title": "Prompt", "maxLength": 3000, "minLength": 1, "description": "Text to synthesize. Reference uploaded audio clips by order with @Audio1, @Audio2, @Audio3." }, "volume": { "type": "number", "default": 1, "maximum": 2, "minimum": 0.5 }, "quantity": { "type": "integer", "title": "Quantity", "minimum": 1, "description": "The number of outputs to generate", "default": 1, "maximum": 4 }, "voice_id": { "enum": [ "zh_male_taocheng_uranus_bigtts", "id_female_bv161narration_uranus_bigtts", "zh_female_cancan_uranus_bigtts", "zh_female_tianmeixiaoyuan_uranus_bigtts", "zh_male_liufei_uranus_bigtts", "zh_female_yingyujiaoxue_uranus_bigtts", "zh_male_m191_uranus_bigtts", "zh_female_xiaoxue_uranus_bigtts", "zh_female_mizai_uranus_bigtts", "zh_male_dayi_uranus_bigtts", "zh_female_xiaohe_uranus_bigtts", "zh_male_sunwukong_uranus_bigtts", "zh_female_jitangnv_uranus_bigtts", "zh_female_meilinvyou_uranus_bigtts", "zh_female_liuchangnv_uranus_bigtts", "zh_male_ruyayichen_uranus_bigtts", "zh_female_sajiaoxuemei_uranus_bigtts", "zh_male_sophie_uranus_bigtts", "zh_female_kefunvsheng_uranus_bigtts", "zh_female_vv_uranus_bigtts" ], "type": "string" }, "guidances": { "type": "object", "properties": { "audio_reference": { "type": "array", "allOf": [ { "type": "array", "items": { "type": "object", "title": "Audio reference", "required": [ "audio" ], "properties": { "audio": { "type": "object", "title": "Audio reference", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Audio URL (enriched by backend when audio is resolved)" }, "type": { "enum": [ "UPLOADED", "GENERATED" ], "type": "string" }, "duration": { "type": "number" } }, "description": "A reference to audio", "additionalProperties": false } } }, "title": "Audio Reference", "description": "Specifies a list of audio references for guidance" } ], "maxItems": 3, "description": "Voice-cloning clips. Cannot be combined with an image reference. voice_id is ignored while an audio or image reference is attached. Each item must be at most 30 seconds. Each item must be under 10 MB." }, "image_reference": { "type": "array", "allOf": [ { "type": "array", "items": { "type": "object", "title": "Image reference", "required": [ "image" ], "properties": { "image": { "type": "object", "allOf": [ {}, {}, {} ], "title": "Image reference", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "description": "Image URL or a base64 data URL. Required when type is URL. The backend enriches resolved image URLs." }, "data": { "type": "string", "description": "Base64-encoded image bytes. Required when type is BASE64.", "format": "byte" }, "type": { "enum": [ "UPLOADED", "GENERATED", "VARIATION", "URL", "BASE64" ], "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "description": "A reference to an image" }, "order": { "type": "integer", "title": "GuidanceOrder", "minimum": 0, "description": "The order at which we want this guidance to be in a list of guidances" } }, "description": "Image reference guidance object, containing parameters available for image reference guidance" }, "title": "Image Reference", "description": "References images to guide your video generation." } ], "maxItems": 1, "description": "An image that guides the voice. Cannot be combined with audio clips. voice_id is ignored while it is attached. Each item must be under 10 MB." } }, "additionalProperties": false }, "language_code": { "enum": [ "en" ], "type": "string", "default": "en" } }, "description": "Seed Audio 1.0 Model Parameters", "additionalProperties": false } }, "example": { "model": "seed-audio-1.0", "parameters": { "pitch": 0, "speed": 1, "prompt": "your prompt here", "volume": 1, "quantity": 1 } } } }, "securitySchemes": { "bearerAuth": { "type": "http", "bearerFormat": "auth-scheme", "description": "Bearer HTTP authentication. Allowed headers `Authorization: Bearer `", "scheme": "bearer" } } }, "security": [ { "bearerAuth": [] } ] } ```