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.