Skip to content
Stella ConnectDocs
Parts

Render an imported 3D part as an image

GET{baseUrl}/v2.0/3d/parts/{PartId}/rendering

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.

Authx-api-key

Field
Type
Required
PartIduuidYes

Field
Type
Required
Description
ImageTypeenum | nullNo

Supported output image formats for render endpoints.

"Png""Svg"
ImageWidthinteger | nullNo
ImageHeightinteger | nullNo

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-part endpoints. Returned inside a ConnectEnvelope<RenderPartResponse>.

data.partIduuidYes

Echo of the PartId that was rendered.

data.imageDatastringYes

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": {
    "partId": "08fcc2e5-7760-493b-b8f1-1ad26fcb0a9e",
    "imageData": "string"
  },
  "errors": [
    {
      "description": "string",
      "errorId": "string"
    }
  ],
  "paging": {
    "limit": 0,
    "start": 0,
    "total": 0
  }
}