Nesting
Render a linear nest to images
POST{baseUrl}/v1.0/nesting/linear/{NestId}/rendering
This endpoint renders a previously created linear nest to one or more images.
You can specify the dimensions of the image, as well as the colors and styles used to represent different elements of the nest (e.g., parts, remnants, dead zones, crop areas).
Note: Rendering a nest does not modify the nest itself; it simply generates visual representations based on the current state of the nest.
Auth
x-api-keyField | Type | Required |
|---|---|---|
| NestId | uuid | Yes |
application/jsonField | Type | Required | Description |
|---|---|---|---|
| imageHeight | integer | null | No | |
| imageWidth | integer | null | No | |
| chuck | object | No | |
| chuck. | string | No | |
| chuck. | enum | null | No | 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. | string | No | |
| chuck. | enum | No | "Solid""Dash""Dot""DashDot""DashDotDot""Custom" |
| kerf | object | No | |
| kerf. | string | No | |
| kerf. | enum | null | No | 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. | string | No | |
| kerf. | enum | No | "Solid""Dash""Dot""DashDot""DashDotDot""Custom" |
| part | object | No | |
| part. | string | No | |
| part. | enum | null | No | 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. | string | No | |
| part. | enum | No | "Solid""Dash""Dot""DashDot""DashDotDot""Custom" |
| remnant | object | No | |
| remnant. | string | No | |
| remnant. | enum | null | No | 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. | string | No | |
| remnant. | enum | No | "Solid""Dash""Dot""DashDot""DashDotDot""Custom" |
Status | When |
|---|---|
| 200 | image/svg |
| 400 | Validation failed or the request was malformed. |
| 401 | Unauthorized |
| 404 | Not Found |
| 500 | Server Error |
Example 200 response
"string"