---
title: "Schemas"
description: "Every schema in the PreForm API 1.0.0-alpha specification."
url: https://developer.formlabs.com/api-reference/schemas/
---

# Schemas

Every schema in the PreForm API 1.0.0-alpha specification.

- [AutoLayoutMode](https://developer.formlabs.com/api-reference/schemas/autolayoutmode.md): Which workspace's layout parameters to use for this call.
- [AutoLayoutRequest](https://developer.formlabs.com/api-reference/schemas/autolayoutrequest.md): Arranges the selected models on the build platform.
- [AutoLayoutResponse](https://developer.formlabs.com/api-reference/schemas/autolayoutresponse.md): The outcome of a layout for every requested model, in the request's `model_ids` order.
- [AutoOrientMode](https://developer.formlabs.com/api-reference/schemas/autoorientmode.md): Selects a specialized auto-orient algorithm.
- [AutoOrientRequest](https://developer.formlabs.com/api-reference/schemas/autoorientrequest.md): Automatically orients the selected models.
- [AutoPackRequest](https://developer.formlabs.com/api-reference/schemas/autopackrequest.md): Packs the selected models within the build volume without duplicating them.
- [AutoPackResponse](https://developer.formlabs.com/api-reference/schemas/autopackresponse.md): The outcome of a pack for every selected visible model.
- [AutoSupportRequest](https://developer.formlabs.com/api-reference/schemas/autosupportrequest.md): Generates supports for the selected models, replacing any supports they already have.
- [BodyCountResult](https://developer.formlabs.com/api-reference/schemas/bodycountresult.md): The number of disconnected mesh bodies making up a single model.
- [BuildVolume](https://developer.formlabs.com/api-reference/schemas/buildvolume.md): The build volume geometry for the scene's printer and material.
- [CageRequest](https://developer.formlabs.com/api-reference/schemas/cagerequest.md): Generates a support cage around the selected models.
- [CageResult](https://developer.formlabs.com/api-reference/schemas/cageresult.md): The cage model a caging operation created.
- [CartridgeData](https://developer.formlabs.com/api-reference/schemas/cartridgedata.md): Cartridge data keyed by cartridge id.
- [CheckManifoldRequest](https://developer.formlabs.com/api-reference/schemas/checkmanifoldrequest.md): Selects the models to check.
- [CreateSceneFpsFile](https://developer.formlabs.com/api-reference/schemas/createscenefpsfile.md): Create a scene from a saved .fps print settings file.
- [CreateSceneLayerThicknessMm](https://developer.formlabs.com/api-reference/schemas/createscenelayerthicknessmm.md): 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/`).
- [CreateSceneManual](https://developer.formlabs.com/api-reference/schemas/createscenemanual.md): A machine/material/print-setting/layer-thickness combination to create a scene for.
- [CreateSceneRequest](https://developer.formlabs.com/api-reference/schemas/createscenerequest.md): Either a manual machine/material/print-setting combination, or a saved .fps print settings file.
- [CreatedScene](https://developer.formlabs.com/api-reference/schemas/createdscene.md): What `/v1/scene/create/` accomplished: the id of the new scene and the print settings it was created with.
- [CupDetectionResult](https://developer.formlabs.com/api-reference/schemas/cupdetectionresult.md): Cup-detection outcome for a single model.
- [DeleteModelRequest](https://developer.formlabs.com/api-reference/schemas/deletemodelrequest.md): Identifies which models in a scene to delete.
- [DentalHollowingRequest](https://developer.formlabs.com/api-reference/schemas/dentalhollowingrequest.md): Cuts, extrudes, and optionally hollows the selected models.
- [DentalHollowingResult](https://developer.formlabs.com/api-reference/schemas/dentalhollowingresult.md): The models dental-hollowing created, per source model, plus any non-fatal warnings.
- [Device](https://developer.formlabs.com/api-reference/schemas/device.md): A device's current status.
- [DeviceConnectionType](https://developer.formlabs.com/api-reference/schemas/deviceconnectiontype.md): How a device is currently connected, if known.
- [DirectionVectors](https://developer.formlabs.com/api-reference/schemas/directionvectors.md): Orientation as two vectors, in model space, that say which way is "up" and "right" once the model is placed in the scene.
- [DiscoverDevicesRequest](https://developer.formlabs.com/api-reference/schemas/discoverdevicesrequest.md): Discovery parameters for `/v1/device/discover/`.
- [DrainHole](https://developer.formlabs.com/api-reference/schemas/drainhole.md): One drain/vent hole to drill into a model.
- [DrillRequest](https://developer.formlabs.com/api-reference/schemas/drillrequest.md): Drills the given drain holes into the selected models.
- [DrillResult](https://developer.formlabs.com/api-reference/schemas/drillresult.md): The result of drilling drain holes into one or more models.
- [DuplicateModelRequest](https://developer.formlabs.com/api-reference/schemas/duplicatemodelrequest.md): Identifies which models in a scene to duplicate, and how many copies to make.
- [DuplicateModelsResult](https://developer.formlabs.com/api-reference/schemas/duplicatemodelsresult.md): The copies a duplicate operation created, per source model.
- [Error](https://developer.formlabs.com/api-reference/schemas/error.md): The envelope returned by every failed request.
- [ErrorCode](https://developer.formlabs.com/api-reference/schemas/errorcode.md): Registry of stable error codes.
- [EulerAngles](https://developer.formlabs.com/api-reference/schemas/eulerangles.md): Orientation as Euler angles in degrees.
- [FillBuildChamberRequest](https://developer.formlabs.com/api-reference/schemas/fillbuildchamberrequest.md): Duplicates the selected models and packs the copies up to fill_to_height_mm.
- [FillBuildPlatformRequest](https://developer.formlabs.com/api-reference/schemas/fillbuildplatformrequest.md): Duplicates the selected models and lays out the copies to fill up the build platform with as many copies as fit.
- [FleetControlPrinterGroup](https://developer.formlabs.com/api-reference/schemas/fleetcontrolprintergroup.md): A Fleet Control queue: a group of one or more printers managed together through a Formlabs Dashboard queue.
- [FlyaroundKeyframe](https://developer.formlabs.com/api-reference/schemas/flyaroundkeyframe.md): One frame of an explicit flyaround camera path.
- [FlyaroundTransform](https://developer.formlabs.com/api-reference/schemas/flyaroundtransform.md): Renders a `.webp` animation instead of a single `.png`.
- [Form2Device](https://developer.formlabs.com/api-reference/schemas/form2device.md)
- [Form3FamilyDevice](https://developer.formlabs.com/api-reference/schemas/form3familydevice.md)
- [Form4FamilyDevice](https://developer.formlabs.com/api-reference/schemas/form4familydevice.md)
- [Fuse1Device](https://developer.formlabs.com/api-reference/schemas/fuse1device.md)
- [GenericDevice](https://developer.formlabs.com/api-reference/schemas/genericdevice.md): A device with no more specific status information available.
- [GetModelBodyCountRequest](https://developer.formlabs.com/api-reference/schemas/getmodelbodycountrequest.md): Identifies which models in a scene to get the body count of.
- [HollowRequest](https://developer.formlabs.com/api-reference/schemas/hollowrequest.md): Hollows the selected models to the given wall thickness.
- [HollowResult](https://developer.formlabs.com/api-reference/schemas/hollowresult.md): The outcome of hollowing for every selected model.
- [ImportModelRequest](https://developer.formlabs.com/api-reference/schemas/importmodelrequest.md): Loads a file and adds it to the scene as a new model.
- [ImportModelResult](https://developer.formlabs.com/api-reference/schemas/importmodelresult.md): The models an import operation created.
- [ImportUnits](https://developer.formlabs.com/api-reference/schemas/importunits.md): The units to interpret the file's coordinates in.
- [ImportedModel](https://developer.formlabs.com/api-reference/schemas/importedmodel.md): A model an import created, and which part of the imported file it came from.
- [InBoundsDetectionRequest](https://developer.formlabs.com/api-reference/schemas/inboundsdetectionrequest.md): Selects the models to check.
- [InBoundsResult](https://developer.formlabs.com/api-reference/schemas/inboundsresult.md): Build-volume verdict for a single model.
- [LabelApplicationMode](https://developer.formlabs.com/api-reference/schemas/labelapplicationmode.md): How a label is applied to a model's surface.
- [LabelRequest](https://developer.formlabs.com/api-reference/schemas/labelrequest.md): Applies a text label to the surface of the selected models, at a given position and orientation.
- [LabelResult](https://developer.formlabs.com/api-reference/schemas/labelresult.md): The result of applying a label to one or more models.
- [LayerThicknessMm](https://developer.formlabs.com/api-reference/schemas/layerthicknessmm.md): A layer thickness in millimeters, or the literal string "ADAPTIVE" for adaptive layer thickness.
- [LayoutBounds](https://developer.formlabs.com/api-reference/schemas/layoutbounds.md): A custom rectangular region of the build platform to lay out within, in user XY coordinates.
- [LayoutOptions](https://developer.formlabs.com/api-reference/schemas/layoutoptions.md): SLA layout parameters shared by the fill-build-platform operation.
- [ListDevicesRequest](https://developer.formlabs.com/api-reference/schemas/listdevicesrequest.md): Optional filter for `/v1/device/list/`.
- [ListModelsRequest](https://developer.formlabs.com/api-reference/schemas/listmodelsrequest.md): Identifies which models in a scene to list.
- [Lock](https://developer.formlabs.com/api-reference/schemas/lock.md): Orientation and position constraints on a model, respected by automatic layout and packing operations.
- [LoginRequest](https://developer.formlabs.com/api-reference/schemas/loginrequest.md): Credentials for `/v1/login/`: either a Dashboard access token, or a username and password.
- [LoginResponse](https://developer.formlabs.com/api-reference/schemas/loginresponse.md): The session tokens for the account that just logged in.
- [MachineTypeId](https://developer.formlabs.com/api-reference/schemas/machinetypeid.md): Canonical machine type id, e.g. "FORM-4-0".
- [ManifoldCheckResult](https://developer.formlabs.com/api-reference/schemas/manifoldcheckresult.md): Manifold-check outcome for a single model.
- [ManifoldCheckStatus](https://developer.formlabs.com/api-reference/schemas/manifoldcheckstatus.md): The manifold library's verdict on a mesh.
- [MaterialCode](https://developer.formlabs.com/api-reference/schemas/materialcode.md): Versioned material code, e.g. "FLGPBK05".
- [MaterialSetting](https://developer.formlabs.com/api-reference/schemas/materialsetting.md): One layer-thickness/print-setting variant of a material.
- [MaterialUsage](https://developer.formlabs.com/api-reference/schemas/materialusage.md): Material consumption for the scene's models.
- [MinimaDetectionResult](https://developer.formlabs.com/api-reference/schemas/minimadetectionresult.md): Unsupported-minima-detection outcome for a single model.
- [ModelProperties](https://developer.formlabs.com/api-reference/schemas/modelproperties.md): The full description of one model in a scene.
- [ModelRepairResult](https://developer.formlabs.com/api-reference/schemas/modelrepairresult.md): Repair outcome for a single model.
- [ModelsCreatedFromSource](https://developer.formlabs.com/api-reference/schemas/modelscreatedfromsource.md): The models an operation created from one existing model: copies of it, bodies split out of it, or a processed model derived from it.
- [ModifiedModels](https://developer.formlabs.com/api-reference/schemas/modifiedmodels.md): What an operation that changes existing models did: which models it changed.
- [NewModelIds](https://developer.formlabs.com/api-reference/schemas/newmodelids.md): The ids of the models a scene-mutating operation added, without describing the rest of the scene's state.
- [OnLayoutFailure](https://developer.formlabs.com/api-reference/schemas/onlayoutfailure.md): What to do when the layout cannot fit every requested model.
- [OnPackFailure](https://developer.formlabs.com/api-reference/schemas/onpackfailure.md): What to do with models the packer could not place inside the build volume.
- [OpenFormRequest](https://developer.formlabs.com/api-reference/schemas/openformrequest.md): Identifies the .form file to load.
- [OpenedScene](https://developer.formlabs.com/api-reference/schemas/openedscene.md): One scene created by `/v1/scene/open/`: a `CreatedScene` plus the scene's name within the `.form` file and the ids of the models loaded into it.
- [Operation](https://developer.formlabs.com/api-reference/schemas/operation.md): The status of a long-running operation started by a `?async=true` request.
- [OperationAccepted](https://developer.formlabs.com/api-reference/schemas/operationaccepted.md): Returned with `202 Accepted` by endpoints called with `?async=true`.
- [OperationStatus](https://developer.formlabs.com/api-reference/schemas/operationstatus.md): The current state of a long-running operation.
- [OperationWithResult](https://developer.formlabs.com/api-reference/schemas/operationwithresult.md): One operation's full record, including (once the operation has finished) the result the originating endpoint would have returned synchronously.
- [OrientRequest](https://developer.formlabs.com/api-reference/schemas/orientrequest.md): Sets the absolute orientation of the selected models.
- [Orientation](https://developer.formlabs.com/api-reference/schemas/orientation.md): A model orientation, given as exactly one of: Euler angles, a transform matrix, or a pair of direction vectors.
- [PackingMode](https://developer.formlabs.com/api-reference/schemas/packingmode.md): Packing objective used to arrange models within the (SLS) build volume.
- [PackingOptions](https://developer.formlabs.com/api-reference/schemas/packingoptions.md): SLS packing parameters shared by the fill-build-chamber operation.
- [PlugCreated](https://developer.formlabs.com/api-reference/schemas/plugcreated.md): A plug model created while drilling drain holes.
- [PrintMaterial](https://developer.formlabs.com/api-reference/schemas/printmaterial.md): A material available on a printer type, with its settings variants.
- [PrintSceneRequest](https://developer.formlabs.com/api-reference/schemas/printscenerequest.md): Slices a scene and uploads the job directly to a printer.
- [PrintSettingCode](https://developer.formlabs.com/api-reference/schemas/printsettingcode.md): Print setting profile code, e.g. "DEFAULT".
- [PrintSettingListRequest](https://developer.formlabs.com/api-reference/schemas/printsettinglistrequest.md): Optionally restricts the print-setting catalog to a single connected printer.
- [PrintSettingValidateOptions](https://developer.formlabs.com/api-reference/schemas/printsettingvalidateoptions.md): Valid values for the one field omitted from the request, given the other three.
- [PrintSettingValidateRequest](https://developer.formlabs.com/api-reference/schemas/printsettingvalidaterequest.md): A (possibly partial) machine_type/material_code/print_setting/ layer_thickness_mm combination to check.
- [PrintSettingValidateResponse](https://developer.formlabs.com/api-reference/schemas/printsettingvalidateresponse.md)
- [PrintSettingsListResponse](https://developer.formlabs.com/api-reference/schemas/printsettingslistresponse.md)
- [PrinterType](https://developer.formlabs.com/api-reference/schemas/printertype.md): A printer type/model and the materials it supports.
- [RaftType](https://developer.formlabs.com/api-reference/schemas/rafttype.md): Which raft style to build under a model's supports.
- [RegenerateSupportsRequest](https://developer.formlabs.com/api-reference/schemas/regeneratesupportsrequest.md): Which supported models to rebuild supports for.
- [RenderRequest](https://developer.formlabs.com/api-reference/schemas/renderrequest.md): Identifies the scene to render and where to save the image.
- [RenderViewType](https://developer.formlabs.com/api-reference/schemas/renderviewtype.md): Camera framing for a render.
- [RepairBehavior](https://developer.formlabs.com/api-reference/schemas/repairbehavior.md): What to do when an imported file needs mesh repair.
- [RepairModelsRequest](https://developer.formlabs.com/api-reference/schemas/repairmodelsrequest.md): Selects the models to repair.
- [ReplaceModelRequest](https://developer.formlabs.com/api-reference/schemas/replacemodelrequest.md): Names the model to replace and the model already in the scene that replaces it.
- [ReplaceModelResult](https://developer.formlabs.com/api-reference/schemas/replacemodelresult.md): The result of replacing a model with another model in the scene.
- [ReplaceWarning](https://developer.formlabs.com/api-reference/schemas/replacewarning.md): A non-fatal problem carrying over the replaced model's supports to its new geometry.
- [SaveSceneRequest](https://developer.formlabs.com/api-reference/schemas/savescenerequest.md): One or more scenes to save as a .form file.
- [ScaleRequest](https://developer.formlabs.com/api-reference/schemas/scalerequest.md): Sets a uniform scale factor on the selected models.
- [Scene](https://developer.formlabs.com/api-reference/schemas/scene.md): A printer/material/print-setting combination and the models placed within its build volume.
- [SceneLayerThicknessMm](https://developer.formlabs.com/api-reference/schemas/scenelayerthicknessmm.md): 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.
- [ScenePosition](https://developer.formlabs.com/api-reference/schemas/sceneposition.md): A position within a printer's build volume, in millimeters, in user coordinate space.
- [SceneSettings](https://developer.formlabs.com/api-reference/schemas/scenesettings.md): Identifies one machine/material/print-setting/layer-thickness combination, as returned by `/v1/print-setting/list/`.
- [SceneType](https://developer.formlabs.com/api-reference/schemas/scenetype.md): The machine/material/print-setting/layer-thickness combination used to create the scene.
- [SlaMaterialUsage](https://developer.formlabs.com/api-reference/schemas/slamaterialusage.md): Material usage for an SLA-type scene (e.g.
- [SlsMaterialUsage](https://developer.formlabs.com/api-reference/schemas/slsmaterialusage.md): Material usage for an SLS-type scene (e.g.
- [SplitModelBodiesRequest](https://developer.formlabs.com/api-reference/schemas/splitmodelbodiesrequest.md): Identifies which models in a scene to split into one model per disconnected body.
- [SplitModelBodiesResult](https://developer.formlabs.com/api-reference/schemas/splitmodelbodiesresult.md): The per-body models a split operation created, per source model.
- [SupportednessDetectionResult](https://developer.formlabs.com/api-reference/schemas/supportednessdetectionresult.md): Supportedness-detection outcome for a single model.
- [ThinWallDetectionRequest](https://developer.formlabs.com/api-reference/schemas/thinwalldetectionrequest.md): Detect thin walls in the selected models against a thickness threshold.
- [ThinWallDetectionResult](https://developer.formlabs.com/api-reference/schemas/thinwalldetectionresult.md): Thin-wall-detection outcome for a single model.
- [TransformMatrix](https://developer.formlabs.com/api-reference/schemas/transformmatrix.md): Orientation as the linear (rotation/scale) part of a 3x3 transform matrix.
- [TranslateMode](https://developer.formlabs.com/api-reference/schemas/translatemode.md): How to interpret the `position` of a translate request.
- [TranslateRequest](https://developer.formlabs.com/api-reference/schemas/translaterequest.md): Moves the selected models.
- [Units](https://developer.formlabs.com/api-reference/schemas/units.md): The measurement units a model was defined in.
- [UnknownMaterialUsage](https://developer.formlabs.com/api-reference/schemas/unknownmaterialusage.md): Material usage for a scene whose machine family this PreFormServer build does not recognize (machine type `UNKN-0-0`).
- [UpdateModelRequest](https://developer.formlabs.com/api-reference/schemas/updatemodelrequest.md): Metadata to apply to the selected models.
- [UpdateModelResult](https://developer.formlabs.com/api-reference/schemas/updatemodelresult.md): What `/v1/scene/model/update/` did: the models it changed, as in `ModifiedModels`, and any side effects it did not perform.
- [UpdateModelWarning](https://developer.formlabs.com/api-reference/schemas/updatemodelwarning.md): A side effect `/v1/scene/model/update/` did not perform on one model.
- [UpdateSceneFpsFile](https://developer.formlabs.com/api-reference/schemas/updatescenefpsfile.md): Update a scene from a saved .fps print settings file.
- [UpdateSceneManual](https://developer.formlabs.com/api-reference/schemas/updatescenemanual.md): A new machine/material/print-setting/layer-thickness combination to apply to the scene.
- [UpdateSceneRequest](https://developer.formlabs.com/api-reference/schemas/updatescenerequest.md): Either a new manual machine/material/print-setting combination, or a saved .fps print settings file, plus the `scene_id` to update.
- [UploadFirmwareRequest](https://developer.formlabs.com/api-reference/schemas/uploadfirmwarerequest.md): Firmware upload parameters for `/v1/device/upload-firmware/`.
- [UserInfo](https://developer.formlabs.com/api-reference/schemas/userinfo.md): Account information for the logged-in Formlabs Dashboard user.