Skip to content

estimate_forge_price

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

Use this tool to check price and verify the workspace has sufficient Creative Units
balance before executing. Does not execute anything.

For forge lifecycle guidance, call get_forge_instructions.

Parameters

ParameterTypeDefaultDescription
model_idrequiredstring (uuid)Model/style ID to use for generation.
weightnumber0–21Style/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.
widthinteger>0Output 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.
heightinteger>0Output 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_sizeinteger1–164Number of outputs to estimate price for (1-16).
duration_secondsnumber>0Video duration in seconds.
promptstringText prompt. Needed for CHARACTER_COUNT pricing models.
generate_audiobooleanGenerate audio with video.
upscale_rationumberUpscale factor (e.g. 2.0, 4.0).
remove_backgroundbooleanRemove the background — pass it here whenever the execute call will, so the estimate reflects the same run.
qualityenumQuality level.
One of: low, medium, high
use_ta_posebooleanDeprecated: use pose_mode. Legacy rig-ready-pose toggle for 3D.
pose_modeenumRest pose for a character mesh: A_POSE or T_POSE. Support varies by model.
One of: A_POSE, T_POSE
include_texturesbooleanInclude textures in 3D output.
quad_meshbooleanGenerate quad mesh.
pbr_materialsbooleanGenerate PBR materials.
low_polybooleanGenerate low-poly mesh.
generate_partsbooleanGenerate separate parts.
detailed_geometrybooleanGenerate denser, more detailed geometry. Costs extra and only some 3D models support it.
export_uvbooleanSet false to omit UV coordinates from the 3D output.
compress_geometrybooleanReturn a geometry-compressed mesh. Only some 3D models support it.
face_limitintegerFace/polygon limit for 3D mesh.
workspace_idrequiredstring (uuid)The user's workspace id.