Skip to content
Stella ConnectDocs
Files

Render an imported 2D CAD file as an image

GET{baseUrl}/v2.0/2d/files/{FileId}/rendering

Renders an imported 2D file to a PNG or SVG image, returned as a base64-encoded string. Get a FileId by uploading a file here.

Authx-api-key

Field
Type
Required
Description
FileIduuidYes

Identifier of the imported file to render.

Field
Type
Required
Description
ImageTypeenum | nullNo

Output image format. Default: Png.

"Png""Svg"
ImageWidthinteger | nullNo

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

ImageHeightinteger | nullNo

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

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-file endpoints. Returned inside a ConnectEnvelope<RenderFileResponse>.

data.fileIduuidYes

Echo of the FileId 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": {
    "fileId": "a1c6a2ab-4b01-4253-b4c9-70e04b3b48fc",
    "imageData": "string"
  },
  "errors": [
    {
      "description": "string",
      "errorId": "string"
    }
  ],
  "paging": {
    "limit": 0,
    "start": 0,
    "total": 0
  }
}