Schemas

The id of the scene containing the models.

Ids of the models to lay out. Omitted or empty means every model in the scene.

Which workspace's layout parameters to use for this call.

Defaults to "DEFAULT"

Minimum gap to leave between models.

At least 0.

Defaults to 1

Allow one model's supports to intersect another model or its supports.

Defaults to false

Only translate models and never rotate them, regardless of their individual lock.

Defaults to false

A custom rectangular region of the build platform to lay out within, in user XY coordinates. All four fields are required together.

Random seed controlling the layout algorithm. Given the same models and settings, the same seed reproduces the same arrangement. Omitted means a random seed is used each call.

At least 0, at most 4294967295.

Number of independent layout attempts to try, keeping the best. Defaults to an algorithm-chosen value, or 200 when seed is set without an explicit value (to keep seeded results deterministic).

At least 1, at most 2500.

Optimization iterations per attempt. Defaults to an algorithm-chosen value, or 25000 when seed is set without an explicit value (to keep seeded results deterministic).

At least 1, at most 250000.

What to do when the layout cannot fit every requested model.

Defaults to "FAIL_AND_LEAVE_SCENE_UNCHANGED"

Maximum number of models that may be ejected before the layout fails outright. Only valid with on_layout_failure: "EJECT_A_MODEL_AND_RETRY". Omitted means no cap.

At least 1.

Requested models that remain in the scene.

Requested models removed from the scene to make the rest fit. Empty unless on_layout_failure is EJECT_A_MODEL_AND_RETRY.

The id of the scene containing the models.

Ids of the models to pack. Omitted or empty means every model in the scene.

Minimum gap to leave between models. Floored at the material's visual collision offset if smaller.

At least 0.

Margin to leave between models and the build volume walls.

At least 0.

Random seed controlling the packing algorithm. Omitted means a random seed is used each call.

At least 0, at most 4294967295.

Packing objective used to arrange models within the (SLS) build volume.

Defaults to "PACK_HEIGHT"

What to do with models the packer could not place inside the build volume.

Defaults to "FAIL_AND_LEAVE_SCENE_UNCHANGED"

Selected visible models that ended inside the build volume.

Selected visible models the packer could not place. Empty unless on_pack_failure is PARK_OUTSIDE_BUILD_VOLUME.

The id of the scene containing the models.

Ids of the models to auto-support. Omitted or empty means every model in the scene.

Support touchpoint density.

At least 0.

Scales how aggressively steep overhangs are supported.

At least 0.

Diameter of each support touchpoint.

At least 0.

Thickness of the raft under the supports.

At least 0.

Vertical gap left between the raft and the model.

At least 0.

Raft thickness compensation applied for print compression.

At least 0.

Height over which nearby touchpoints are merged into wider bases.

At least 0.

Generate only the touchpoints the model strictly needs to print (a faster, reduced-fidelity pass) instead of the full support structure.

Defaults to false

Which raft style to build under a model's supports.

Engrave the model's name on its raft. The text is fixed when the supports are generated: renaming the model afterwards does not change it until the supports are regenerated. Pass false for a raft whose geometry does not depend on the model's name.

Use breakaway supports. Only accepted when the scene's material supports this option.

Generate internal supports for enclosed cavities.

Number of disconnected bodies (connected mesh components) making up this model. 1 for an ordinary single-body model.

Build volume size in millimeters.

Radius of the build volume's corner fillets, in millimeters.

The id of the scene containing the models.

Ids of the models to cage. Omitted or empty means every model in the scene.

Display name for the new cage model. Defaults to an auto-generated name ("Cage 1", "Cage 2", ...).

Emboss cage_label as a physical label on the cage geometry.

Defaults to true

Gap left between adjacent cage bars.

At least 0.

Thickness of each cage bar.

At least 1.

Width of each cage bar.

At least 1.

Gap left between the models and the surrounding cage.

At least 0.

Round off the edges of the cage bars.

Defaults to false

Give the cage bars a rectangular cross-section rather than a round one.

Defaults to true

The id of the newly created cage model. The selected models are now children of this model.

The id of the scene containing the models.

Ids of the models to check. Omitted or empty means every model in the scene.

Full path to the .fps file.

Canonical machine type id, e.g. "FORM-4-0".

Versioned material code, e.g. "FLGPBK05".

Print setting profile code, e.g. "DEFAULT".

A layer thickness in millimeters, accepted as a JSON number, the literal string "ADAPTIVE" for adaptive layer thickness, or a numeric value formatted as a string (e.g. "0.025"). "ADAPTIVE" is accepted only where the settings catalog offers an adaptive variant, on older printer models (see /v1/print-setting/list/).

A machine/material/print-setting/layer-thickness combination to create a scene for.

Create a scene from a saved .fps print settings file. Custom print settings are persisted so the scene's scene_settings.custom_print_setting_id can identify them later.

Unique identifier of the new scene.

The machine/material/print-setting/layer-thickness combination used to create the scene.

Number of cup cavities detected in the model's current orientation. 0 means no suction risk from cups.

At least 0.

The id of the scene containing the models.

Ids of the models to delete. Omitted or empty means every model in the scene.

The id of the scene containing the models.

Ids of the models to process. Omitted or empty means every model in the scene.

Absolute height of the cut plane. Mutually exclusive with cutoff_below_gumline_mm.

Offset of the cut plane from each model's automatically detected gumline. Only used when cutoff_height_mm is omitted. 0 (the default) cuts exactly at the gumline.

Defaults to 0

Length of solid material extruded downward from the cut plane to create a printable base.

Also hollow the resulting model.

Defaults to false

Thickness of the hollow shell wall. Defaults to 2.75 if omitted. Only used when hollow is true. Rejected otherwise.

At least 0.

Thickness of the honeycomb infill walls inside the hollow cavity (not the outer shell, which is shell_thickness_mm). Defaults to 1 if omitted. Only used when hollow is true. Rejected otherwise.

At least 0.01.

Minor-axis radius of the drain holes generated in the hollow shell. Defaults to 1.5 if omitted. Only used when hollow is true. Rejected otherwise.

At least 0.

Ratio of a drain hole's major axis to drain_hole_radius_mm. 1 (the default) produces a circular hole and larger values elongate it. Only used when hollow is true. Rejected otherwise.

Greater than 0.

Minimum distance between generated drain holes; candidates closer than this to another hole are dropped. Defaults to 2 if omitted. Only used when hollow is true. Rejected otherwise.

At least 0.

Maximum number of drain holes generated per contour on the bottom of the model. Defaults to 2 if omitted. Only used when hollow is true. Rejected otherwise.

At least 0.

Fill the hollow cavity with honeycomb infill. Only used when hollow is true. Rejected otherwise.

Defaults to true

Smooth contours that are extended down to the build platform when creating the base.

Defaults to true

Keep every disconnected piece of the cut mesh instead of dropping all but the largest. Defaults to the scene's configured default if omitted.

One entry per selected model, in request order. Each entry's new_model_ids name the processed model created from that model (exactly one today, though the array form leaves room for processing that yields several). The source model no longer exists in the scene.

Free-text, non-fatal problems encountered while processing.

Free-text informational notices, if any.

A device with no more specific status information available.

A Fleet Control queue: a group of one or more printers managed together through a Formlabs Dashboard queue.

Unit vector in model space that will point up (+Z) in the scene.

Exactly 3 items.

Unit vector in model space, perpendicular to z_direction, that will point right (+X) in the scene.

Exactly 3 items.

Number of seconds to wait for devices to be found.

At least 0.

Defaults to 60

Address of a single device to wait for, instead of discovering broadly. Printer serial name, IP address, or Fleet Control Queue id.

A model orientation, given as exactly one of: Euler angles, a transform matrix, or a pair of direction vectors.

A position within a printer's build volume, in millimeters, in user coordinate space.

Diameter of the drilled hole.

Greater than 0.

Fixed hole depth, or the literal string "AUTO" to infer the depth by searching into the model along the hole's axis.

How far the hole extends outward past the model's surface (the reverse of the drilling direction), to cleanly cut the surface edge.

At least 0.

Defaults to 1

Also generate a removable plug model matching this hole.

Defaults to false

Upper bound on the depth search. Only accepted together with depth_mm: "AUTO".

At least 0.

The id of the scene containing the models.

Ids of the models to drill. Omitted or empty means every model in the scene.

At least 1 items.

One entry per plug model created for holes with create_plug: true. Empty if no plugs were created.

Free-text, non-fatal problems drilling individual holes, identified by their index into the request's drain_holes.

Free-text informational notices, if any.

The id of the scene containing the models.

Ids of the models to duplicate. Omitted or empty means every model in the scene.

The number of copies to create of each selected model.

At least 1, at most 1000.

One entry per selected model, in request order. Each entry's new_model_ids are the copies created from that model. The source models themselves are unchanged.

Rotation in degrees around the x axis (applied second).

Rotation in degrees around the y axis (applied last).

Rotation in degrees around the z axis (applied first).

The id of the scene containing the models.

Ids of the models to duplicate. Omitted or empty means every model in the scene.

SLS packing parameters shared by the fill-build-chamber operation.

Height, in mm above the build platform, to fill up to. Defaults to the scene's full build volume height.

Greater than 0.

The id of the scene containing the models.

Ids of the models to duplicate. Omitted or empty means every model in the scene.

SLA layout parameters shared by the fill-build-platform operation.

The group's stable identifier.

Human-readable status message. Not machine-readable. Never match on its value.

How a device is currently connected, if known.

Always empty, since a printer group has no single firmware version.

Id of the group on Formlabs Dashboard.

Id of the Fleet Control queue on Formlabs Dashboard.

If newly uploaded jobs print automatically instead of being queued.

If the queue is currently paused.

If the group includes a Form Auto.

The individual printers currently in this group.

Camera yaw for this frame, in degrees.

Camera pitch for this frame, in degrees.

Explicit list of camera keyframes to render, one per animation frame.

At least 2 items.

Number of evenly-spaced frames to render around a full 360-degree turn. Ignored if transform is present.

At least 1.

When true, every frame is rendered at the same size (the largest needed by any frame) instead of each frame being cropped independently.

Defaults to true

The printer's serial name.

Human-readable status message. Not machine-readable. Never match on its value.

How a device is currently connected, if known.

Milliseconds remaining in the current print, if any, and 0 otherwise.

Versioned material code, e.g. "FLGPBK05".

Cartridge data keyed by cartridge id. Unlike every other v1 response field, the keys inside each entry are camelCase, not snake_case: this object is a verbatim passthrough of the printer's internal cartridge tracking data.

If newly uploaded jobs print automatically instead of being queued.

The printer's serial name.

Human-readable status message. Not machine-readable. Never match on its value.

How a device is currently connected, if known.

If the printer can be started remotely via Formlabs Dashboard.

Milliseconds remaining in the current print, if any, and 0 otherwise.

Versioned material code, e.g. "FLGPBK05".

Cartridge data keyed by cartridge id. Unlike every other v1 response field, the keys inside each entry are camelCase, not snake_case: this object is a verbatim passthrough of the printer's internal cartridge tracking data.

Human-readable Form Auto status message. Not machine-readable. Never match on its value.

If newly uploaded jobs print automatically instead of being queued.

The printer's serial name.

Human-readable status message. Not machine-readable. Never match on its value.

How a device is currently connected, if known.

If the printer can be started remotely via Formlabs Dashboard.

Milliseconds remaining in the current print, if any, and 0 otherwise.

Versioned material code, e.g. "FLGPBK05".

Cartridge data keyed by cartridge id. Unlike every other v1 response field, the keys inside each entry are camelCase, not snake_case: this object is a verbatim passthrough of the printer's internal cartridge tracking data.

If newly uploaded jobs print automatically instead of being queued.

The printer's serial name.

Human-readable status message. Not machine-readable. Never match on its value.

How a device is currently connected, if known.

If the printer can be started remotely via Formlabs Dashboard.

Milliseconds remaining in the current print, if any, and 0 otherwise.

Human-readable powder level message. Not machine-readable. Never match on its value.

Index of the layer currently printing, if any.

Id of the print job currently loaded, if any.

Versioned material code, e.g. "FLGPBK05".

Versioned material code, e.g. "FLGPBK05".

Remaining powder credit, in grams.

If newly uploaded jobs print automatically instead of being queued.

The device's serial name or other stable identifier.

Human-readable status message. Not machine-readable. Never match on its value.

How a device is currently connected, if known.

Present only when connected directly over the local network.

If newly uploaded jobs print automatically instead of being queued. Present only for devices that can receive prints.

The id of the scene containing the models.

Ids of the models to inspect. Omitted or empty means every model in the scene.

The id of the scene containing the models.

Ids of the models to hollow. Omitted or empty means every model in the scene.

Thickness of the shell wall left after hollowing.

At least 0.1.

Smallest feature size the generated inner surface will resolve. Smaller is higher quality and slower. Values above 1 are silently clamped to 1.

At least 0.05.

Defaults to 1

How closely the inner surface follows the model's true offset surface: 1 is highest quality and slowest, 0 is fastest and coarsest.

At least 0, at most 1.

Defaults to 0.5

Selected models that were hollowed. Never empty.

Selected models that could not be hollowed and were left unchanged. Each one also has a line in warnings.

Free-text, non-fatal problems hollowing individual models (e.g. wall_thickness_mm too large for a model's geometry), one line per model in unhollowed_model_ids, followed by a suggestion to check manifoldness when any model failed.

Free-text informational notices, if any.

The id of the scene to import into.

Full path to the file to load.

What to do when an imported file needs mesh repair.

Defaults to "ERROR"

Display name for the new model. Defaults to a name derived from the file name.

The units to interpret the file's coordinates in.

Defaults to "DETECTED"

Orientation and position constraints on a model, respected by automatic layout and packing operations.

Defaults to "FREE"

Tessellation chordal tolerance, in micrometers. Only affects CAD file imports.

Defaults to 10

Tessellation angle tolerance, in degrees. Only affects CAD file imports.

Defaults to 5

Whether a CAD or 3MF file holding several parts is imported as one model per part. Off by default: the parts arrive as a single combined model, and name and lock apply to it. No effect on STL or OBJ.

Defaults to false

One entry per created model, in no particular order. Exactly one entry unless split_multi_model_file split the file into several models. Use each entry's source_part_name / source_part_index, never its array position, to identify which part of the file it came from.

Id of the created model.

The name of the part this model was created from, as read from the imported file, before any renaming applied by the scene or the request's name override. Parts with no name in the file get a generated name derived from the file name. Use source_part_index when part names cannot be trusted to identify parts.

Zero-based position of the source part within the imported file, counting every part in the file (including parts that failed to import). A single-model import reports 0. This is the stable identity for split assemblies whose parts share a name.

The id of the scene containing the models.

Ids of the models to check. Omitted or empty means every model in the scene.

Whether the model, including its supports, fits inside the build volume at its current position, orientation and scale. The same verdict as the in_bounds field of /v1/scene/model/list/.

The id of the scene containing the models.

Ids of the models to label. Omitted or empty means every model in the scene.

A model orientation, given as exactly one of: Euler angles, a transform matrix, or a pair of direction vectors.

A position within a printer's build volume, in millimeters, in user coordinate space.

The text to render.

How a label is applied to a model's surface.

Defaults to "EMBOSS"

Label character height.

At least 2, at most 20.

Height above the surface (EMBOSS) or depth into it (ENGRAVE).

At least 0.2, at most 10.

Free-text, non-fatal problems encountered while applying the label (e.g. individual characters that could not be created).

Free-text informational notices, if any.

Minimum gap to leave between models.

At least 0.

Defaults to 1

Margin to leave between models and the build platform edge.

At least 0.

Defaults to 2.5

Allow one model's supports to intersect another model or its supports.

Defaults to false

Only translate models and never rotate them, regardless of their individual lock.

Defaults to false

Number of independent layout attempts to try, keeping the best. Defaults to an algorithm-chosen value.

At least 1, at most 2500.

Optimization iterations per attempt. Defaults to an algorithm-chosen value.

At least 1, at most 250000.

Device ids to look up, as returned in each device's id. Every id must belong to a currently connected device, or the whole request fails. See the endpoint's Error codes table.

The id of the scene containing the models.

Ids of the models to list. Omitted or empty means every model in the scene.

Access token for the newly created session.

Refresh token for the newly created session. Empty when logging in with access_token rather than a username and password.

Whether the model's mesh is a manifold solid. Equivalent to status == "MANIFOLD".

The manifold library's verdict on a mesh. Only MANIFOLD means the mesh is a valid manifold solid.

Display label, e.g. "0.025 mm (Default settings)".

Identifies one machine/material/print-setting/layer-thickness combination, as returned by /v1/print-setting/list/. The same field names are used by /v1/print-setting/validate/.

Material usage for an SLA-type scene (e.g. Form 4).

Material usage for an SLS-type scene (e.g. Fuse 1+, Fuse X1).

Number of unsupported local minima detected on the model. 0 means every low point is currently supported.

At least 0.

Unique identifier of the model within its scene.

Display name used within job preparation.

A position within a printer's build volume, in millimeters, in user coordinate space.

Orientation as Euler angles in degrees. Rotations are applied in the order z, then x, then y.

Scale factor applied to the model.

The measurement units a model was defined in.

Axis-aligned bounding box of the model (including generated geometry such as supports) in scene coordinates. Group containers have an empty bounding box, serialized as all zeros.

Path of the file the model was imported from.

Whether the model is currently shown in the scene.

Whether support structures have been generated for the model.

Whether this entry is a Part Group container rather than a regular printable model. Group containers have zero volume and an empty bounding box.

Whether the group is a cage. Cages are a subset of groups, so is_cage: true implies is_group: true.

Whether the model lies entirely within the build volume.

Hash of the raw mesh data, before any transform.

Hash of the mesh data together with its position, orientation, and scale.

Orientation and position constraints on a model, respected by automatic layout and packing operations.

Defaults to "FREE"

The manifold library's verdict on the repaired mesh, equivalent to a /v1/scene/model/validate/manifoldness/ status of MANIFOLD. false means the best-effort repair left residual defects in the mesh (it was still replaced in the scene).

The id of the model the new models were created from.

Ids of the models created from it, in no particular order.

The selected models the operation was applied to.

Ids of the newly created models, in no particular order.

Path to the .form file to load.

Unique identifier of the new scene.

The machine/material/print-setting/layer-thickness combination used to create the scene.

Ids of the newly created models, in no particular order.

Name of this scene within the .form file, distinguishing multiple print jobs saved in one file. The scene remembers it, and /v1/scene/save/ writes it back.

The operation's id, as returned in operation_id when it was started.

The current state of a long-running operation.

Progress of the operation, from 0.0 to 1.0.

Randomly generated id of the tracked operation.

Server-relative URL of this operation's record: /v1/operation/get/?operation_id=<operation_id>. GET it to follow progress and retrieve the result.

Human-readable pointer to where the result will appear. Purely informational. Use operation_url programmatically.

The operation's id, as returned in operation_id when it was started.

The current state of a long-running operation.

Progress of the operation, from 0.0 to 1.0.

Present once status is SUCCEEDED or FAILED, absent while IN_PROGRESS. On success this is the JSON body the originating endpoint documents as its 200 response. On failure it is the standard error envelope (error.code, error.message). Endpoints whose synchronous success response has no body leave result absent even after success.

The id of the scene containing the models.

Ids of the models to orient. Omitted or empty means every model in the scene.

A model orientation, given as exactly one of: Euler angles, a transform matrix, or a pair of direction vectors.

Orientation as Euler angles in degrees. Rotations are applied in the order z, then x, then y.

Orientation as the linear (rotation/scale) part of a 3x3 transform matrix.

Orientation as two vectors, in model space, that say which way is "up" and "right" once the model is placed in the scene.

Minimum gap to leave between models. Floored at the material's visual collision offset if smaller.

At least 0.

Margin to leave between models and the build volume walls.

At least 0.

Random seed controlling the packing algorithm. Omitted means a random seed is used each call.

At least 0, at most 4294967295.

The id of the newly created plug model.

The id of the pre-existing model that was drilled: the model the plug was cut from and fits back into.

Display name, e.g. "Black V5".

Short marketing description of the material. May be empty.

Every layer-thickness/print-setting variant of this material.

The id of the scene to print.

Printer serial name, IP address, or Fleet Control Queue id.

Name of the job.

Number of seconds to wait to find the given printer.

At least 0.

Defaults to 30

If true, the job must print immediately. This fails with OPERATION_FAILED if the printer's ready_to_print_now status is not true. If false, the job is uploaded to the printer's local queue instead of printing immediately. Omitting this field defers to the printer's current ready_to_print_now state: prints immediately if ready, queues otherwise.

A connected printer's serial name.

Canonical machine type id, e.g. "FORM-4-0".

Versioned material code, e.g. "FLGPBK05".

Print setting profile code, e.g. "DEFAULT".

A layer thickness in millimeters, or the literal string "ADAPTIVE" for adaptive layer thickness. A numeric value formatted as a string (e.g. "0.025") is also accepted on input.

Whether at least one shipped print setting matches the fields given.

Valid values for the one field omitted from the request, given the other three. Exactly one of these four properties is present.

Every printer type PreForm ships print settings for, or the single matching connected printer's type if compatible_with was given.

Display name, e.g. "Form 4".

Canonical machine type ids this entry covers.

Marketing product names this entry covers.

Build volume dimensions in millimeters, as [x, y, z].

Exactly 3 items.

The id of the scene containing the models.

Ids of the models whose supports to regenerate. Omitted or empty means every model in the scene that has supports.

The id of the scene to render.

Path to save the rendered image to. Must end in .png or .webp. .webp is required when flyaround_transform is present.

Matches `^.*\.(png|webp)$`.

Ids of the models to make visible in the render (and candidates for ZOOM_ON_MODELS framing). Omitted or [] means every model in the scene.

Defaults to []

Camera framing for a render.

Defaults to "ZOOM_ON_MODELS"

Maximum image width/height, in pixels. The render is square.

Defaults to 820

Whether to crop the frame tightly around the visible models instead of leaving margin.

Defaults to true

Camera yaw, in degrees. Ignored when flyaround_transform.transform is present.

Defaults to 45

Camera pitch, in degrees. Ignored when flyaround_transform.transform is present.

Defaults to 35.264

Renders a .webp animation instead of a single .png. Provide either an explicit transform keyframe list, or frame_count to auto-generate evenly-spaced frames around a full turn starting from the top-level yaw/pitch. At least one of the two is required.

The id of the scene containing the models.

Ids of the models to repair. Omitted or empty means every model in the scene.

The id of the scene containing both models.

The id of the model to replace. It is removed from the scene.

The id of the model that takes over model_id's pose and supports. It keeps this id and its own layout lock. Must differ from model_id.

Path to write the .form file to.

At least 1 characters.

Ids of the scenes to save, in order. A single id saves a single-build-volume .form file. More than one saves a multi-build-volume project file.

At least 1 items.

Name of the project inside the file, returned by /v1/scene/open/. Omitted means no name is stored.

The id of the scene containing the models.

Ids of the models to scale. Omitted or empty means every model in the scene.

The scale factor to apply. Replaces each model's current scale outright. It is not multiplied against the existing value.

Greater than 0.

Unique identifier of the scene.

The models currently in the scene.

The machine/material/print-setting/layer-thickness combination used to create the scene.

Material consumption for the scene's models. The shape depends on the scene's printer family. An unrecognized family reports an empty object.

Number of layers the scene would slice to.

The build volume geometry for the scene's printer and material.

X position. 0 is the center of the build volume. Positive moves right as you face the printer.

Y position. 0 is the center of the build volume. Positive moves away from you as you face the printer.

Vertical position. 0 is the surface of the build platform.

Canonical machine type id, e.g. "FORM-4-0".

Versioned material code, e.g. "FLGPBK05".

Print setting profile code, e.g. "DEFAULT".

A layer thickness in millimeters, or the literal string "ADAPTIVE" for adaptive layer thickness. A numeric value formatted as a string (e.g. "0.025") is also accepted on input.

Canonical machine type id, e.g. "FORM-4-0".

Versioned material code, e.g. "FLGPBK05".

Print setting profile code, e.g. "DEFAULT".

Layer thickness in millimeters, always returned as a string: either a numeric string (e.g. "0.025") or the literal "ADAPTIVE" for adaptive layer thickness. Contrast with /v1/print-setting/list/ and /v1/print-setting/validate/, whose layer_thickness_mm is a JSON number (or "ADAPTIVE").

Id of the custom print setting the scene was created or updated from, if any (via fps_file). Absent when the scene uses a material-based print setting.

Total volume of models and supports in the scene, in milliliters.

Total volume of models alone, not including supports, in milliliters.

Total volume of powder used, including unsintered support powder, in milliliters.

Total mass of powder used, including unsintered support powder, in kilograms.

Volume of powder that ends up sintered (part of the finished print), in milliliters.

Mass of powder that ends up sintered (part of the finished print), in kilograms.

Ratio of sintered powder mass to the total build volume.

The id of the scene containing the models.

Ids of the models to split. Omitted or empty means every model in the scene.

One entry per selected model, in request order. Each entry's new_model_ids are the per-body models split out of that model, in no particular order (each body's name carries its "(Body N)" index). The source model no longer exists in the scene.

Percentage of the model's surface that is undersupported in its current orientation and support configuration. 0 means fully supported.

At least 0, at most 100.

The id of the scene containing the models.

Ids of the models to analyze. Omitted or empty means every model in the scene, including non-printable ones.

Wall thickness threshold, in millimeters. Regions thinner than this are flagged as thin.

Greater than 0.

Per-model analysis outcome. ANALYZED: analysis ran (see the other fields). TOO_SMALL: too small/thin to voxelize (sub-~2-voxel extent or sub-voxel shell). TOO_LARGE: too large to voxelize within the memory budget at this resolution (often a units mistake). MESH_ERROR: the mesh could not be rasterized (degenerate/broken geometry). For any non-ANALYZED status the model could not be assessed: has_thin_walls is false and thin_regions is empty. These are per-model outcomes, not request errors, and other models still return normally.

Whether any thin region was found.

Sum of all detected thin regions' volumes, in cubic millimeters. 0 if has_thin_walls is false.

Number of distinct thin regions detected, equal to the length of thin_regions.

At least 0.

Per-region breakdown, sorted by volume descending. Empty if has_thin_walls is false.

A 3x3 matrix, given as 3 rows of 3 numbers.

Exactly 3 items.

The id of the scene containing the models.

Ids of the models to translate. Omitted or empty means every model in the scene.

A position within a printer's build volume, in millimeters, in user coordinate space.

How to interpret the position of a translate request.

Defaults to "ABSOLUTE"

The id of the scene containing the models.

Ids of the models to update. Omitted or empty means every model in the scene.

Display name to apply. Applying to more than one model at once gives all of them this same name.

The measurement units a model was defined in.

Orientation and position constraints on a model, respected by automatic layout and packing operations.

Defaults to "FREE"

The selected models the update was applied to.

The model the warning is about.

The id of the scene to update.

Full path to the .fps file.

The id of the scene to update.

Canonical machine type id, e.g. "FORM-4-0".

Versioned material code, e.g. "FLGPBK05".

Print setting profile code, e.g. "DEFAULT".

A layer thickness in millimeters, accepted as a JSON number, the literal string "ADAPTIVE" for adaptive layer thickness, or a numeric value formatted as a string (e.g. "0.025"). "ADAPTIVE" is accepted only where the settings catalog offers an adaptive variant, on older printer models (see /v1/print-setting/list/).

A new machine/material/print-setting/layer-thickness combination to apply to the scene.

Update a scene from a saved .fps print settings file. Custom print settings are persisted so the scene's scene_settings.custom_print_setting_id can identify them later.

Printer serial name, IP address, or Fleet Control Queue id.

Path, on the machine running PreFormServer, to the firmware .formware or .formware2 file to upload.

Formlabs Dashboard account username or email address.

Account email address.

Formlabs Dashboard account id.

Account holder's first name.

Account holder's last name.