Render an imported 3D part as an image
Renders an imported 3D part to a PNG or SVG image, returned as a
base64-encoded string. Get a PartId by uploading a file here
— every imported file yields one or more parts.
x-api-keyField | Type | Required |
|---|---|---|
| PartId | uuid | Yes |
Field | Type | Required | Description |
|---|---|---|---|
| ImageType | enum | null | No | Supported output image formats for render endpoints. "Png""Svg" |
| ImageWidth | integer | null | No | |
| ImageHeight | integer | null | No |
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 |
|---|---|---|---|
| data | object | null | No | Response payload for the render-part endpoints. Returned inside a
|
| data. | uuid | Yes | Echo of the |
| data. | string | Yes | Rendered image, base64-encoded. Decode to bytes and interpret according to
the requested |
| errors[] | object[] | null | No | One or more errors describing why the request failed. Absent ( |
| errors[]. | string | null | No | 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[]. | string | null | No | Machine-readable, stable error identifier. Consumers should branch on this value
rather than on Description. See |
| paging | object | null | No | Paging metadata for list endpoints. Absent on single-item responses. |
| paging. | integer | No | |
| paging. | integer | No | |
| paging. | integer | No |
{
"data": {
"partId": "08fcc2e5-7760-493b-b8f1-1ad26fcb0a9e",
"imageData": "string"
},
"errors": [
{
"description": "string",
"errorId": "string"
}
],
"paging": {
"limit": 0,
"start": 0,
"total": 0
}
}