Skip to content
Stella ConnectDocs
Parts

Render a linear nesting as an image

POST{baseUrl}/v2.0/3d/parts/nesting/{NestId}/rendering/linear

Renders a previously computed linear nesting to a PNG or SVG image, returned as a base64-encoded string. Get a NestId by calling LinearPartsNesting3D or LinearPartsPartLookupNesting3D — the returned NestingId is what to pass here.

Authx-api-key

Field
Type
Required
Description
NestIduuidYes

Identifier of the nesting to render — the NestingId returned by the linear-nesting endpoints.

application/json
Field
Type
Required
Description
imageTypeenumNo

Output image format. Default: Png.

"Png""Svg"
imageWidthinteger | nullNo

Width of the rendered image in pixels. Must be greater than 0. Default: 1280.

imageHeightinteger | nullNo

Height of the rendered image in pixels. Must be greater than 0. Default: 1024.

chuckobjectNo

Styling for the chuck region drawn at the start of every stock bar.

chuck.fillColorstringNo

Fill color as an HTML hex string. Supports optional alpha: #RGB, #RRGGBB, or #AARRGGBB. Default: #00000000 (fully transparent).

chuck.hatchStyleenum | nullNo

Hatch pattern applied on top of FillColor. Values are those of HatchStyle (e.g. Horizontal, Cross, ForwardDiagonal, Percent50). Null means no hatching.

Show 53 values
"Horizontal""Vertical""ForwardDiagonal""BackwardDiagonal""Cross""DiagonalCross""Percent05""Percent10""Percent20""Percent25""Percent30""Percent40""Percent50""Percent60""Percent70""Percent75""Percent80""Percent90""LightDownwardDiagonal""LightUpwardDiagonal""DarkDownwardDiagonal""DarkUpwardDiagonal""WideDownwardDiagonal""WideUpwardDiagonal""LightVertical""LightHorizontal""NarrowVertical""NarrowHorizontal""DarkVertical""DarkHorizontal""DashedDownwardDiagonal""DashedUpwardDiagonal""DashedHorizontal""DashedVertical""SmallConfetti""LargeConfetti""ZigZag""Wave""DiagonalBrick""HorizontalBrick""Weave""Plaid""Divot""DottedGrid""DottedDiamond""Shingle""Trellis""Sphere""SmallGrid""SmallCheckerBoard""LargeCheckerBoard""OutlinedDiamond""SolidDiamond"
chuck.strokeColorstringNo

Stroke color as an HTML hex string. Default: #000000 (black).

chuck.strokeStyleenumNo

Stroke dash pattern. One of Solid, Dash, Dot, DashDot, DashDotDot, Custom. Default: Solid.

"Solid""Dash""Dot""DashDot""DashDotDot""Custom"
kerfobjectNo

Styling for the kerf (saw-blade waste) drawn between adjacent parts.

kerf.fillColorstringNo

Fill color as an HTML hex string. Supports optional alpha: #RGB, #RRGGBB, or #AARRGGBB. Default: #00000000 (fully transparent).

kerf.hatchStyleenum | nullNo

Hatch pattern applied on top of FillColor. Values are those of HatchStyle (e.g. Horizontal, Cross, ForwardDiagonal, Percent50). Null means no hatching.

Show 53 values
"Horizontal""Vertical""ForwardDiagonal""BackwardDiagonal""Cross""DiagonalCross""Percent05""Percent10""Percent20""Percent25""Percent30""Percent40""Percent50""Percent60""Percent70""Percent75""Percent80""Percent90""LightDownwardDiagonal""LightUpwardDiagonal""DarkDownwardDiagonal""DarkUpwardDiagonal""WideDownwardDiagonal""WideUpwardDiagonal""LightVertical""LightHorizontal""NarrowVertical""NarrowHorizontal""DarkVertical""DarkHorizontal""DashedDownwardDiagonal""DashedUpwardDiagonal""DashedHorizontal""DashedVertical""SmallConfetti""LargeConfetti""ZigZag""Wave""DiagonalBrick""HorizontalBrick""Weave""Plaid""Divot""DottedGrid""DottedDiamond""Shingle""Trellis""Sphere""SmallGrid""SmallCheckerBoard""LargeCheckerBoard""OutlinedDiamond""SolidDiamond"
kerf.strokeColorstringNo

Stroke color as an HTML hex string. Default: #000000 (black).

kerf.strokeStyleenumNo

Stroke dash pattern. One of Solid, Dash, Dot, DashDot, DashDotDot, Custom. Default: Solid.

"Solid""Dash""Dot""DashDot""DashDotDot""Custom"
partobjectNo

Styling for the part bodies laid on each stock bar.

part.fillColorstringNo

Fill color as an HTML hex string. Supports optional alpha: #RGB, #RRGGBB, or #AARRGGBB. Default: #00000000 (fully transparent).

part.hatchStyleenum | nullNo

Hatch pattern applied on top of FillColor. Values are those of HatchStyle (e.g. Horizontal, Cross, ForwardDiagonal, Percent50). Null means no hatching.

Show 53 values
"Horizontal""Vertical""ForwardDiagonal""BackwardDiagonal""Cross""DiagonalCross""Percent05""Percent10""Percent20""Percent25""Percent30""Percent40""Percent50""Percent60""Percent70""Percent75""Percent80""Percent90""LightDownwardDiagonal""LightUpwardDiagonal""DarkDownwardDiagonal""DarkUpwardDiagonal""WideDownwardDiagonal""WideUpwardDiagonal""LightVertical""LightHorizontal""NarrowVertical""NarrowHorizontal""DarkVertical""DarkHorizontal""DashedDownwardDiagonal""DashedUpwardDiagonal""DashedHorizontal""DashedVertical""SmallConfetti""LargeConfetti""ZigZag""Wave""DiagonalBrick""HorizontalBrick""Weave""Plaid""Divot""DottedGrid""DottedDiamond""Shingle""Trellis""Sphere""SmallGrid""SmallCheckerBoard""LargeCheckerBoard""OutlinedDiamond""SolidDiamond"
part.strokeColorstringNo

Stroke color as an HTML hex string. Default: #000000 (black).

part.strokeStyleenumNo

Stroke dash pattern. One of Solid, Dash, Dot, DashDot, DashDotDot, Custom. Default: Solid.

"Solid""Dash""Dot""DashDot""DashDotDot""Custom"
remnantobjectNo

Styling for the remnant region left after the final cut on each stock bar.

remnant.fillColorstringNo

Fill color as an HTML hex string. Supports optional alpha: #RGB, #RRGGBB, or #AARRGGBB. Default: #00000000 (fully transparent).

remnant.hatchStyleenum | nullNo

Hatch pattern applied on top of FillColor. Values are those of HatchStyle (e.g. Horizontal, Cross, ForwardDiagonal, Percent50). Null means no hatching.

Show 53 values
"Horizontal""Vertical""ForwardDiagonal""BackwardDiagonal""Cross""DiagonalCross""Percent05""Percent10""Percent20""Percent25""Percent30""Percent40""Percent50""Percent60""Percent70""Percent75""Percent80""Percent90""LightDownwardDiagonal""LightUpwardDiagonal""DarkDownwardDiagonal""DarkUpwardDiagonal""WideDownwardDiagonal""WideUpwardDiagonal""LightVertical""LightHorizontal""NarrowVertical""NarrowHorizontal""DarkVertical""DarkHorizontal""DashedDownwardDiagonal""DashedUpwardDiagonal""DashedHorizontal""DashedVertical""SmallConfetti""LargeConfetti""ZigZag""Wave""DiagonalBrick""HorizontalBrick""Weave""Plaid""Divot""DottedGrid""DottedDiamond""Shingle""Trellis""Sphere""SmallGrid""SmallCheckerBoard""LargeCheckerBoard""OutlinedDiamond""SolidDiamond"
remnant.strokeColorstringNo

Stroke color as an HTML hex string. Default: #000000 (black).

remnant.strokeStyleenumNo

Stroke dash pattern. One of Solid, Dash, Dot, DashDot, DashDotDot, Custom. Default: Solid.

"Solid""Dash""Dot""DashDot""DashDotDot""Custom"

Status
When
200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

An unexpected error occurred on the server.

Field
Type
Required
Description
dataobject | nullNo

Response payload for the render-linear-nest endpoint. Returned inside a ConnectEnvelope<RenderLinearNestResponse>.

data.nestIduuidNo

Echo of the NestId that was rendered.

data.imageDatastringNo

Rendered image, base64-encoded. Decode to bytes and interpret according to the requested ImageType (PNG or SVG).

errors[]object[] | nullNo

One or more errors describing why the request failed. Absent (null) on success.

errors[].descriptionstring | nullNo

Human-readable explanation of the error. Intended for display to end users or logs. Wording is not stable and should not be branched on.

errors[].errorIdstring | nullNo

Machine-readable, stable error identifier. Consumers should branch on this value rather than on Description. See ConnectErrorIds for the catalog.

pagingobject | nullNo

Paging metadata for list endpoints. Absent on single-item responses.

paging.limitintegerNo
paging.startintegerNo
paging.totalintegerNo

Example 200 response
{
  "data": {
    "nestId": "99d4d3b5-18a3-4e18-b6c3-a40bd48c02fa",
    "imageData": "string"
  },
  "errors": [
    {
      "description": "string",
      "errorId": "string"
    }
  ],
  "paging": {
    "limit": 0,
    "start": 0,
    "total": 0
  }
}