Describe a PDF drawing as structured JSON

Returns units, bounds and size, entity and segment counts, per-layer entries with the color actually drawn, per-type entity counts, skipped (unsupported) types, and the drawing's text content (title blocks and dimension values included). Use for structural questions — layers, counts, dimensions, what the drawing says.

get/describe-pdf

Request

  • Base URL: https://aspicio-api.frontsail.app
  • URL: https://aspicio-api.frontsail.app/describe-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.

Response

Structured summary of the drawing

formatstring required

Which format was read ("dxf", "pdf")

unitsstring required

Drawing unit label ("mm", "in", …) or "" when unitless

spacestring nullable required

Which space this summary is scoped to, or null when it covers the whole drawing (in which case bounds/size describe spaces[0], the space render returns)

entityCountinteger required
segmentCountinteger required
entityTypesobject required

Top-level entities per DXF type

unsupportedobject required

Per-type counts of skipped (unsupported) entities

textsstring[]

Unique TEXT/MTEXT strings, including inside blocks reachable via inserts and dimensions (title blocks, dimension values)

Changes

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