---
title: "Create a geometry primitive for reference within a Simulation spec"
method: POST
path: "/projects/{projectId}/geometryprimitives"
tags: ["Simulations"]
---

# Create a geometry primitive for reference within a Simulation spec

`POST /projects/{projectId}/geometryprimitives`

## Request body

- union
  - GeometryPrimitiveCartesianBox
    - `type` string, required — Schema name: CartesianBox
    - `id` string, uuid
    - `name` string
    - `min` GeometryPrimitiveDimensionalVectorLength
      - `value` GeometryPrimitiveDecimalVector
        - `x` number
        - `y` number
        - `z` number
      - `unit` 'm' | 'in' | 'mm' | 'cm' | 'ft' | 'yd', required
    - `max` GeometryPrimitiveDimensionalVectorLength
      - `value` GeometryPrimitiveDecimalVector
        - `x` number
        - `y` number
        - `z` number
      - `unit` 'm' | 'in' | 'mm' | 'cm' | 'ft' | 'yd', required
  - GeometryPrimitiveRotatableCartesianBox
    - `type` string, required — Schema name: RotatableCartesianBox
    - `id` string, uuid
    - `name` string
    - `min` GeometryPrimitiveDimensionalVectorLength
      - `value` GeometryPrimitiveDecimalVector
        - `x` number
        - `y` number
        - `z` number
      - `unit` 'm' | 'in' | 'mm' | 'cm' | 'ft' | 'yd', required
    - `max` GeometryPrimitiveDimensionalVectorLength
      - `value` GeometryPrimitiveDecimalVector
        - `x` number
        - `y` number
        - `z` number
      - `unit` 'm' | 'in' | 'mm' | 'cm' | 'ft' | 'yd', required
    - `rotationPoint` GeometryPrimitiveDimensionalVectorLength
      - `value` GeometryPrimitiveDecimalVector
        - `x` number
        - `y` number
        - `z` number
      - `unit` 'm' | 'in' | 'mm' | 'cm' | 'ft' | 'yd', required
    - `rotationAngles` GeometryPrimitiveDimensionalVectorAngle
      - `value` GeometryPrimitiveDecimalVector
        - `x` number
        - `y` number
        - `z` number
      - `unit` 'rad' | '°', required
  - GeometryPrimitiveLocalCartesianBox
    - `type` string, required — Schema name: LocalCartesianBox
    - `id` string, uuid
    - `name` string
    - `orientationReference` 'GEOMETRY' | 'FLOW_DOMAIN'
    - `min` GeometryPrimitiveDimensionalVectorLength
      - `value` GeometryPrimitiveDecimalVector
        - `x` number
        - `y` number
        - `z` number
      - `unit` 'm' | 'in' | 'mm' | 'cm' | 'ft' | 'yd', required
    - `max` GeometryPrimitiveDimensionalVectorLength
      - `value` GeometryPrimitiveDecimalVector
        - `x` number
        - `y` number
        - `z` number
      - `unit` 'm' | 'in' | 'mm' | 'cm' | 'ft' | 'yd', required
  - GeometryPrimitiveSphere
    - `type` string, required — Schema name: Sphere
    - `id` string, uuid
    - `name` string
    - `center` GeometryPrimitiveDimensionalVectorLength
      - `value` GeometryPrimitiveDecimalVector
        - `x` number
        - `y` number
        - `z` number
      - `unit` 'm' | 'in' | 'mm' | 'cm' | 'ft' | 'yd', required
    - `radius` GeometryPrimitiveDimensionalLength
      - `value` number
      - `unit` 'm' | 'in' | 'mm' | 'cm' | 'ft' | 'yd', required
  - GeometryPrimitiveLocalSphere
    - `type` string, required — Schema name: LocalSphere
    - `id` string, uuid
    - `name` string
    - `orientationReference` 'GEOMETRY' | 'FLOW_DOMAIN'
    - `center` GeometryPrimitiveDimensionalVectorLength
      - `value` GeometryPrimitiveDecimalVector
        - `x` number
        - `y` number
        - `z` number
      - `unit` 'm' | 'in' | 'mm' | 'cm' | 'ft' | 'yd', required
    - `radius` GeometryPrimitiveDimensionalLength
      - `value` number
      - `unit` 'm' | 'in' | 'mm' | 'cm' | 'ft' | 'yd', required
  - GeometryPrimitiveCylinder
    - `type` string, required — Schema name: Cylinder
    - `id` string, uuid
    - `name` string
    - `reference` GeometryPrimitiveDimensionalVectorLength
      - `value` GeometryPrimitiveDecimalVector
        - `x` number
        - `y` number
        - `z` number
      - `unit` 'm' | 'in' | 'mm' | 'cm' | 'ft' | 'yd', required
    - `axis` GeometryPrimitiveDimensionalVectorLength
      - `value` GeometryPrimitiveDecimalVector
        - `x` number
        - `y` number
        - `z` number
      - `unit` 'm' | 'in' | 'mm' | 'cm' | 'ft' | 'yd', required
    - `radius` GeometryPrimitiveDimensionalLength
      - `value` number
      - `unit` 'm' | 'in' | 'mm' | 'cm' | 'ft' | 'yd', required
  - GeometryPrimitivePoint
    - `type` string, required — Schema name: Point
    - `id` string, uuid
    - `name` string
    - `center` GeometryPrimitiveDimensionalVectorLength
      - `value` GeometryPrimitiveDecimalVector
        - `x` number
        - `y` number
        - `z` number
      - `unit` 'm' | 'in' | 'mm' | 'cm' | 'ft' | 'yd', required
  - GeometryPrimitiveBox
    - `type` string, required — Schema name: Box
    - `id` string, uuid
    - `name` string
    - `scale` GeometryPrimitiveDecimalVector
      - `x` number
      - `y` number
      - `z` number
    - `translation` GeometryPrimitiveDimensionalVectorLength
      - `value` GeometryPrimitiveDecimalVector
        - `x` number
        - `y` number
        - `z` number
      - `unit` 'm' | 'in' | 'mm' | 'cm' | 'ft' | 'yd', required
    - `rotationAxis` GeometryPrimitiveDimensionalVectorLength
      - `value` GeometryPrimitiveDecimalVector
        - `x` number
        - `y` number
        - `z` number
      - `unit` 'm' | 'in' | 'mm' | 'cm' | 'ft' | 'yd', required
    - `rotationAngle` GeometryPrimitiveDimensionalAngle
      - `value` number
      - `unit` 'rad' | '°', required
  - GeometryPrimitiveHalfSpace
    - `type` string, required — Schema name: HalfSpace
    - `id` string, uuid
    - `name` string
    - `referencePoint` GeometryPrimitiveDimensionalVectorLength
      - `value` GeometryPrimitiveDecimalVector
        - `x` number
        - `y` number
        - `z` number
      - `unit` 'm' | 'in' | 'mm' | 'cm' | 'ft' | 'yd', required
    - `normal` GeometryPrimitiveDimensionalVectorLength
      - `value` GeometryPrimitiveDecimalVector
        - `x` number
        - `y` number
        - `z` number
      - `unit` 'm' | 'in' | 'mm' | 'cm' | 'ft' | 'yd', required
  - GeometryPrimitiveLocalHalfSpace
    - `type` string, required — Schema name: LocalHalfSpace
    - `id` string, uuid
    - `name` string
    - `orientationReference` 'GEOMETRY' | 'FLOW_DOMAIN'
    - `referencePoint` GeometryPrimitiveDimensionalVectorLength
      - `value` GeometryPrimitiveDecimalVector
        - `x` number
        - `y` number
        - `z` number
      - `unit` 'm' | 'in' | 'mm' | 'cm' | 'ft' | 'yd', required
    - `normal` GeometryPrimitiveDimensionalVectorLength
      - `value` GeometryPrimitiveDecimalVector
        - `x` number
        - `y` number
        - `z` number
      - `unit` 'm' | 'in' | 'mm' | 'cm' | 'ft' | 'yd', required

## Response `201`

Successful creation of the geometry primitive.

- GeometryPrimitiveResponse
  - `geometryPrimitiveId` string, uuid, required — The ID of the created geometry primitive.

## Other responses

- `400` — Bad request.
- `404` — Not found.

---

[API](https://skmtc.net/simscale/apis/simscale-api.md) · [All operations](https://skmtc.net/simscale/apis/simscale-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/simscale/simscale-api/revisions/53223abaceb7/schema)