MeshRequestΒΆ

Generated from the central API contract. Availability and permissions are checked by the connected service.

Field

Type / accepted values

Required

Default

Constraints / meaning

project_id

string (uuid) or null

No

Omitted

surface_artifact_id

string

Yes

Omitted

minLength: 1; maxLength: 128; pattern: "^[A-Za-z0-9_-]+$"

reviewed_job_id

string (uuid) or null

No

Omitted

Explicitly requested new attempt after reviewing this completed mesh job, including quality or resource failures. Use a fresh idempotency key; this records lineage and never restarts the prior execution.

engine

"structured" / "openfoam" / "octree_prism"

Yes

Omitted

structured = Cartesian; octree_prism = octree/polyhedral with prism layers; openfoam = legacy engine identifier. Prefer configured octree_prism for generic unstructured requests; preserve explicit methods. Choose delivered file formats separately with export_formats.

export_formats

array of "cgns" / "gd_cgns" / "fluent" / "openfoam"

No

["cgns"]

minItems: 1; maxItems: 4; Delivered mesh formats, in preference order. Default cgns is Standard CGNS (NGON/NFACE) for ParaView/Luminary. gd_cgns is GD CGNS for Fluxcore/Studio; fluent is polyhedral .msh for Fluent/STAR-CCM+; openfoam is a polyMesh archive for OpenFOAM/SimScale/Fidelity. Select formats independently of the meshing engine. The first format is the primary download. GD CGNS is also retained internally for simulation and viewing. Preserve an explicit user choice; do not ask for a format when none was specified.

target_cells

integer

No

1000000

minimum: 1000.0; maximum: 20000000.0

structured

StructuredOptions or null

No

Omitted

openfoam

OpenFoamOptions or null

No

Omitted

octree_prism

OctreePrismOptions or null

No

Omitted

decision_context

DecisionContext

No

Omitted

Omission and explicit null are different. Defaults shown are schema defaults; validators may resolve conditional defaults or reject incompatible combinations. See the workflow guide and validate the complete request before submission.