Design operation reference¶
All engineering operations, including implicit modelling, pass through the central API/MCP service. These routes are conditional on the service’s available capabilities. They are not separate customer geometry servers.
Discover using get_design_operation_schema; invoke using call_design_operation. Each request supplies name, body and any path_parameters. Returned edits are candidate documents, not saved Studio revisions. See implicit design workflows.
catalogue¶
List feature operations and material/engineering catalogues.
REST: GET /v1/engineering/design/catalogue. Scopes: geometry:read.
Body: None.
template¶
Read an editable native design template.
REST: GET /v1/engineering/design/templates/{name}. Scopes: geometry:read.
Body: None.
Field |
Type / accepted values |
Required |
Default |
Constraints / meaning |
|---|---|---|---|---|
|
string |
Yes |
Omitted |
validate¶
Validate an entire editable design document.
REST: POST /v1/engineering/design/validate. Scopes: geometry:write.
Body: DesignDocument.
edit¶
Apply a typed feature-graph edit to the supplied document; returns a proposed document, never saves a Studio project.
REST: POST /v1/engineering/design/edit. Scopes: geometry:write.
Body: EditRequest.
manufacturing¶
Check hard/preferred manufacturing constraints.
REST: POST /v1/engineering/design/manufacturing. Scopes: geometry:write.
Body: DocumentRequest.
manufacturing_pack¶
Evaluate a manufacturing rule pack against the supplied document.
REST: POST /v1/engineering/design/manufacturing/pack. Scopes: geometry:write.
Body: PackRequest.
upgrade_template¶
Propose a document upgraded to the current template.
REST: POST /v1/engineering/design/upgrade-template. Scopes: geometry:write.
Body: DesignDocument.
evaluate¶
Evaluate features and generate bounded mesh/engineering previews; may run CPU compute.
REST: POST /v1/engineering/design/evaluate. Scopes: geometry:write.
Body: EvaluateRequest.
section¶
Sample a section of an actual implicit body; may run CPU compute.
REST: POST /v1/engineering/design/section. Scopes: geometry:write.
Body: SectionRequest.
models¶
Discover models applicable to this design document.
REST: POST /v1/engineering/design/physics/models. Scopes: geometry:write.
Body: ModelsRequest.
predict¶
Run a native design model prediction; preserve its ROM/AI/solver evidence label.
REST: POST /v1/engineering/design/predict. Scopes: geometry:write, predictions:write.
Body: PredictRequest.
study_conditions¶
Discover operating conditions and model availability for a study.
REST: POST /v1/engineering/design/study/conditions. Scopes: geometry:write.
Body: DocumentRequest.
study_plan¶
Plan a bounded parameter/material study using native constraints.
REST: POST /v1/engineering/design/study/plan. Scopes: geometry:write.
Body: StudyRequest.
study¶
Execute a bounded native parameter study; may run compute. This synchronous call is not a durable CFD job.
REST: POST /v1/engineering/design/study. Scopes: geometry:write, predictions:write.
Body: StudyRequest.
simulation_regions¶
Inspect the design’s fluid and solid regions for meshing/CHT.
REST: POST /v1/engineering/design/simulation/regions. Scopes: geometry:write.
Body: ModelsRequest.
thermal_power_map¶
Resolve editable heat sources and heat flux for display; does not run simulation.
REST: POST /v1/engineering/design/thermal/power-map. Scopes: geometry:write.
Body: ThermalRequest.
thermal_case¶
Inspect the cold plate’s materials, operating conditions and power-conserving heat map; does not run a solver.
REST: POST /v1/engineering/design/thermal/case. Scopes: geometry:write.
Body: ThermalRequest.
import¶
Import supported small CAD/field files supplied as base64; return an editable document. Subject to the MCP request-size ceiling.
REST: POST /v1/engineering/design/import. Scopes: geometry:write.
Body: ImportRequest.