# execute_forge Execute a forge run to generate images, videos, 3D models, or audio. Returns immediately with an inference ID, which can be polled with \`get\_forge\_run\` for results. Call \`get\_forge\_instructions\` first for full forge lifecycle guidance. ## Parameters | Parameter | Type | Default | Description | | ------------------------------- | -------------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | model\_idrequired | string (uuid) | — | Model/style ID to use for generation. | | weight | number0–2 | 1 | Style/LoRA strength applied to the model. 1.0 = as trained; lower weakens, higher over-applies the style. Only affects LoRA/adapter-backed styles; ignored for models without a trainable adapter. | | prompt | string | — | Text prompt describing what to generate. | | width | integer\>0 | — | Output width in pixels. Pass both width and height whenever the output must have a specific aspect ratio: with either one absent and an init image, editing reference, or first frame attached, the output geometry is taken from that file rather than from a model default. | | height | integer\>0 | — | Output height in pixels. Pass both width and height whenever the output must have a specific aspect ratio: with either one absent and an init image, editing reference, or first frame attached, the output geometry is taken from that file rather than from a model default. | | batch\_size | integer1–16 | 4 | Number of outputs to generate (1-16). | | seed | integer | \-1 | Random seed. -1 for random. | | guidance\_files | ForgeGuidanceFileInput\[\] | \[\] | Reference images/files to guide generation. | | file\_idrequired | string (uuid) | — | File ID of an uploaded file. | | typerequired | string | — | Guidance type: init, reference\_image, pose, depth, canny, softedge\_hed, segmentation, lineart, prompt (style reference), face, first\_frame, last\_frame, init\_video, audio, init\_mesh, texture\_image, scribble, color\_sketch, editing\_reference. See model capabilities for supported types per model. | | weight | number0–1 | — | Influence weight (0-1). Defaults to 0.5 for init, 1 for others. | | mask | ForgeMaskInput | — | Mask for inpainting/outpainting. Provide file\_id or transparency flags. | | file\_id | string (uuid) | — | Mask image file ID. | | for\_transparency | boolean | — | Use transparent areas as mask. | | for\_nontransparency | boolean | — | Use non-transparent areas as mask. | | edge\_radius | integer≥0 | 0 | Mask edge blur radius in pixels. | | num\_inference\_steps | integer | — | Number of diffusion steps. | | guidance\_scale | number | — | Guidance scale (CFG). | | prompt\_strength | number0–1 | — | Prompt strength for img2img (0-1). | | quality | enum | — | Quality level.One of: low, medium, high | | sharpness | number | — | Output sharpness. | | duration\_seconds | number | — | Video duration in seconds. | | generate\_audio | boolean | — | Generate audio with video. | | keep\_audio | boolean | — | Keep audio from input video. | | fps | integer | — | FPS for LTX video generation (e.g. 25 or 50). | | video\_effects | ForgeVideoEffectInput\[\] | \[\] | Video effects to apply. | | typerequired | string | — | Video effect type (UPPERCASE). Common types: GENERAL, ORBIT\_360, DOLLY\_IN, DOLLY\_OUT, ZOOM\_IN, ZOOM\_OUT, CRANE\_UP, CRANE\_DOWN, TILT\_UP, TILT\_DOWN, STATIC, FPV\_DRONE, HYPERLAPSE, HANDHELD. See model capabilities for supported effects per model. | | weight | number0–100 | — | Effect strength (0-100). | | frame\_extraction\_location | enum | — | Which frame to extract from an input video: first, middle, or last. Used by ffmpeg-extract-frame and similar models.One of: first, last, middle, timestamp | | use\_ta\_pose | boolean | — | Deprecated: use pose\_mode. Legacy rig-ready-pose toggle for 3D. | | pose\_mode | enum | — | Rest pose for a character mesh: A\_POSE or T\_POSE. Support varies by model.One of: A\_POSE, T\_POSE | | include\_textures | boolean | — | Include textures in 3D output. | | quad\_mesh | boolean | — | Generate quad mesh. | | pbr\_materials | boolean | — | Generate PBR materials. | | low\_poly | boolean | — | Generate low-poly mesh. | | generate\_parts | boolean | — | Generate separate parts. | | detailed\_geometry | boolean | — | Generate denser, more detailed geometry. Costs extra and only some 3D models support it. | | export\_uv | boolean | — | Set false to omit UV coordinates from the 3D output. | | compress\_geometry | boolean | — | Return a geometry-compressed mesh. Only some 3D models support it. | | face\_limit | integer | — | Face/polygon limit for 3D mesh. | | stability | number0–1 | — | Audio stability (0-1). | | use\_speaker\_boost | boolean | — | Boost speaker clarity. | | similarity\_boost | number0–1 | — | Voice similarity boost (0-1). | | style\_exaggeration | number0–1 | — | Style exaggeration (0-1). | | speed | number | — | Speech speed multiplier. | | upscale\_ratio | number | — | Upscale factor (e.g. 2.0, 4.0). | | creativity | number | — | Creative variation strength for upscaling. | | resemblance | number | — | Resemblance to original for upscaling. | | vectorize | boolean | — | Vectorize the output image. | | vectorization\_mode | enum | — | SVG path mode: 'spline' (curved) or 'polygon' (straight lines).One of: spline, polygon | | vectorization\_color\_mode | enum | — | SVG color output: 'color' or 'binary' (black and white).One of: color, binary | | vectorization\_filter\_speckle | integer0–128 | — | Filter out small speckles and noise when vectorizing (0-128). | | vectorization\_color\_precision | integer1–8 | — | Color quantization level when vectorizing (1-8). | | remove\_background | boolean | — | Remove the background. Effective as the standalone operation on a background-removal model; a generation model does not chain removal onto its outputs on this surface. | | reframe | boolean | — | Reframe/extend the image. | | refill | boolean | — | Outpaint/refill transparent areas. | | workspace\_idrequired | string (uuid) | — | The user's workspace id. | | session\_id | string (uuid) | — | The Session ID to attach the results to. | | session\_name | string | — | Creates a new session with this name. One of \`session\_name\` or \`session\_id\` must specified, but not both. |