FrontSail Render Doc API

openapi: 3.2.0
info:
  title: Aspicio DXF and PDF Render 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: Render Doc
paths:
  /render-doc:
    get:
      operationId: renderDoc
      summary: Render a drawing to an image
      description: 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).
      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'
      - $ref: '#/components/parameters/format'
      - $ref: '#/components/parameters/width'
      - $ref: '#/components/parameters/bg'
      responses:
        '200':
          description: The rendered image
          content:
            image/png:
              schema:
                type: string
                format: binary
            image/svg+xml:
              schema:
                type: string
        '400':
          description: Bad input (src, space, format, or bg invalid)
          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:
      - Render Doc
    post:
      operationId: renderDocUpload
      summary: Render an uploaded drawing to an image
      description: Same as GET /render, but the drawing file is the request body.
      parameters:
      - $ref: '#/components/parameters/space'
      - $ref: '#/components/parameters/format'
      - $ref: '#/components/parameters/width'
      - $ref: '#/components/parameters/bg'
      requestBody:
        required: true
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary
      responses:
        '200':
          description: The rendered image
          content:
            image/png:
              schema:
                type: string
                format: binary
            image/svg+xml:
              schema:
                type: string
        '400':
          description: Bad input (space, format or bg invalid, empty body)
          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:
      - Render Doc
components:
  parameters:
    bg:
      name: bg
      in: query
      description: 'Background: a hex color like "#16181d" (URL-encode the #), or "none" for transparent. Default dark slate.'
      schema:
        type: string
        pattern: ^(#[0-9a-fA-F]{3,8}|none)$
        default: '#16181d'
    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
    width:
      name: width
      in: query
      description: PNG width in pixels (default 1200)
      schema:
        type: integer
        minimum: 1
        maximum: 4000
        default: 1200
    format:
      name: format
      in: query
      description: Image format (default png)
      schema:
        type: string
        enum:
        - png
        - svg
        default: png
  schemas:
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: string
          description: Human-readable failure reason