FrontSail Describe Doc API
The Describe Doc API from FrontSail — 1 operation(s) for describe doc.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/frontsail-app:frontsail-app-describe-doc-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Aspicio DXF and PDF Describe Doc API
version: 1.0.0
description: Inspect and render drawings — DXF/CAD and the vector content of PDF. A `describe` returns structured JSON facts (the format read, layers with the colors actually drawn, units, bounds, entity counts, text content); a `render` returns the drawing as a PNG or SVG image. `/describe` and `/render` read DXF only, `/describe-pdf` and `/render-pdf` read PDF only, and `/describe-doc` and `/render-doc` accept either and detect the format from the bytes; a typed endpoint handed the wrong format answers 422 naming the one that would have worked. A PDF render shows vector line work and text, not a page facsimile. Input is a fetched `src` URL or the file POSTed as the request body. Drawing endpoints are rate-limited per client IP.
license:
name: MIT
url: https://github.com/frontsail-ai/aspicio/blob/master/LICENSE
servers:
- url: https://aspicio-api.frontsail.app
security: []
tags:
- name: Describe Doc
paths:
/describe-doc:
get:
operationId: describeDoc
summary: Describe a drawing as structured JSON
description: 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.
parameters:
- name: src
in: query
required: true
description: Publicly reachable http(s) URL of a drawing file (DXF or PDF, detected from the bytes). Alternatively, POST the drawing file itself as the request body and omit this parameter.
schema:
type: string
format: uri
- $ref: '#/components/parameters/space'
responses:
'200':
description: Structured summary of the drawing
content:
application/json:
schema:
$ref: '#/components/schemas/DrawingSummary'
'400':
description: Bad input (missing/invalid src, unknown space, private address refused)
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'413':
description: The drawing exceeds the 8 MB limit
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'422':
description: The file could not be parsed as any supported format
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Rate limit exceeded (per client IP)
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'502':
description: Fetching the src URL failed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- Describe Doc
post:
operationId: describeDocUpload
summary: Describe an uploaded drawing
description: Same as GET /describe, but the drawing file is the request body.
parameters:
- $ref: '#/components/parameters/space'
requestBody:
required: true
content:
application/octet-stream:
schema:
type: string
format: binary
responses:
'200':
description: Structured summary of the drawing
content:
application/json:
schema:
$ref: '#/components/schemas/DrawingSummary'
'400':
description: Empty request body, or unknown space
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'413':
description: The drawing exceeds the 8 MB limit
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'422':
description: The file could not be parsed as any supported format
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Rate limit exceeded (per client IP)
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- Describe Doc
components:
schemas:
SpaceSummary:
type: object
required:
- name
- entityCount
- segmentCount
- bounds
- size
properties:
name:
type: string
description: Pass to the `space` parameter to scope to it
entityCount:
type: integer
segmentCount:
type: integer
bounds:
oneOf:
- type: object
required:
- minX
- minY
- maxX
- maxY
properties:
minX:
type: number
minY:
type: number
maxX:
type: number
maxY:
type: number
- type: 'null'
size:
oneOf:
- type: object
required:
- width
- height
properties:
width:
type: number
height:
type: number
- type: 'null'
DrawingSummary:
type: object
required:
- format
- units
- bounds
- size
- space
- entityCount
- segmentCount
- spaces
- layers
- entityTypes
- unsupported
properties:
format:
type: string
description: Which format was read ("dxf", "pdf")
units:
type: string
description: Drawing unit label ("mm", "in", …) or "" when unitless
bounds:
oneOf:
- type: object
required:
- minX
- minY
- maxX
- maxY
properties:
minX:
type: number
minY:
type: number
maxX:
type: number
maxY:
type: number
- type: 'null'
description: World-space extents, or null for an empty drawing
size:
oneOf:
- type: object
required:
- width
- height
properties:
width:
type: number
height:
type: number
- type: 'null'
description: Bounding-box size in drawing units
space:
oneOf:
- type: string
- type: 'null'
description: 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)
entityCount:
type: integer
segmentCount:
type: integer
spaces:
type: array
items:
$ref: '#/components/schemas/SpaceSummary'
description: 'Every space in the drawing (a PDF''s pages, a DXF''s model space and layouts), model space first. These do not sum to entityCount: a DXF sheet''s viewports re-show model geometry, so an entity can be drawn in two spaces while existing once'
layers:
type: array
items:
$ref: '#/components/schemas/LayerSummary'
entityTypes:
type: object
additionalProperties:
type: integer
description: Top-level entities per DXF type
unsupported:
type: object
additionalProperties:
type: integer
description: Per-type counts of skipped (unsupported) entities
texts:
type: array
items:
type: string
description: Unique TEXT/MTEXT strings, including inside blocks reachable via inserts and dimensions (title blocks, dimension values)
Error:
type: object
required:
- error
properties:
error:
type: string
description: Human-readable failure reason
LayerSummary:
type: object
required:
- name
- entityCount
- visible
- color
properties:
name:
type: string
entityCount:
type: integer
visible:
type: boolean
color:
type: string
description: 'The color actually drawn on this layer (entity overrides included), #rrggbb'
parameters:
space:
name: space
in: query
description: '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.'
schema:
type: string