estimate_forge_price

Estimate the Creative Units price of a forge run before executing it.

Requires either a `base_model_id` or at least one reference set; passing neither is an error.
Prices through the same reference-set translation and model selection as `execute_forge`, so
the returned price matches what execution charges for identical inputs. Executes nothing.

For forge lifecycle guidance, call get_forge_instructions.

Parameters

Parameter	Type	Default	Description
base_model_id	string	—	Base model to price, given as an id (e.g. flux-dev), display name, or community alias. Not required when passing reference sets — a model is then auto-picked from them. Required otherwise.
reference_sets	ForgeReferenceSetInput[]	[]	Reference Sets the run will attach. Required when no base_model_id is given.
set_idrequired	string (uuid)	—	Reference Set ID, from `list_reference_sets`.
weight	number0–2	1	Weight for the set's LoRA adapter when one applies. 1.0 = as trained; lower weakens, higher over-applies. Ignored for sets applied as reference images or prompt text.
modality	enum	—	Output modality: image, video, three_d, or audio. Used to disambiguate reference-set translation; inferred from the reference sets when omitted. One of: text, image, audio, video, three_d, playable
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 estimate price for (1-16).
duration_seconds	number>0	—	Output length in seconds — video clip length, or audio clip length for models whose duration_seconds_min / duration_seconds_max say they take one.
prompt	string	—	Text prompt. Needed for CHARACTER_COUNT pricing models.
generate_audio	boolean	—	Generate audio with video.
upscale_ratio	number	—	Upscale factor (e.g. 2.0, 4.0).
remove_background	boolean	—	Remove the background — pass it here whenever the execute call will, so the estimate reflects the same run.
camera	ForgeCameraInput	—	Camera view change the execute call will pass — include it here for parity, so the estimated model can be checked for camera_transform support before money is spent.
yaw_degrees	number-360–360	—	Orbit horizontally around the subject, in degrees: 90 = right side view, 180 = back view, 270 (or -90) = left side view.
pitch_degrees	number-30–90	—	Camera elevation in degrees: positive looks down (90 = top-down), negative looks up (-30 is the lowest supported angle).
roll_degrees	number	—	Bank around the viewing axis in degrees, clockwise positive. Natively camera-capable models ignore roll.
distance_delta	number	—	Dolly out (positive) / in (negative), in scene units; ~5 spans wide shot to close-up.
fov_delta_degrees	number	—	Field-of-view change in degrees: positive widens (zoom out), negative narrows. Alternative to distance_delta.
quality	enum	—	Quality level. One of: low, medium, high
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.
workspace_idrequired	string (uuid)	—	The user's workspace id.