Render a PDF drawing to an image

Returns the whole drawing as a PNG (default) or SVG. Use for visual questions — what the drawing looks like. For measurements and structure, prefer /describe (never measure pixels).

get/render-pdf

Request

  • Base URL: https://aspicio-api.frontsail.app
  • URL: https://aspicio-api.frontsail.app/render-pdf
  • Auth: none required

Query parameters

srcstring uri required

Publicly reachable http(s) URL of a .pdf file. Alternatively, POST the PDF file itself as the request body and omit this parameter.

spacestring

Which space to work on: "Model" (a PDF's page 1, a DXF's model space) or a page/layout name as listed in a describe reply's "spaces". Describe omits it for the whole drawing; render defaults to the first space. A name the drawing does not have is a 400.

format'png' | 'svg'

Image format (default png)

widthinteger

PNG width in pixels (default 1200)

bgstring

Background: a hex color like "#16181d" (URL-encode the #), or "none" for transparent. Default dark slate.

Response

The rendered image

Changes

No recorded changes to this operation across all 1 revision of this API.