# 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.                                                                                                                                                                                                                                                       |