Export API — Generate Manufacturing Files

ProtoPulse’s export system converts your circuit design into the file formats used by PCB fabricators, EDA tools, and procurement systems. All export endpoints follow the same pattern: a POST request with the project ID in the body returns a binary file download with the appropriate Content-Type and Content-Disposition headers set. Some formats also run a DRC gate before generating output — if violations are present the server returns 422 Unprocessable Entity instead of the file. All export endpoints require a valid X-Session-Id header. See REST API Overview for authentication details.

Supported formats

Format	Path	Output file(s)	Description
`kicad`	`/api/projects/:projectId/export/kicad`	`.kicad_sch` + `.kicad_pcb` + `.kicad_pro` (ZIP)	Full KiCad 6/7 project for use in KiCad EDA
`eagle`	`/api/projects/:projectId/export/eagle`	`.sch` + `.brd` (ZIP)	Autodesk Eagle project (XML format)
`spice`	`/api/projects/:projectId/export/spice`	`.cir`	SPICE netlist compatible with LTspice, ngspice, and other SPICE simulators
`bom-csv`	`/api/projects/:projectId/export/bom`	`.csv`	Bill of materials. Supports `generic`, `jlcpcb`, `mouser`, and `digikey` column formats
`gerber`	`/api/projects/:projectId/export/gerber`	ZIP (RS-274X layers)	Fabrication-ready Gerber files: copper layers, solder mask, silkscreen, paste; requires DRC pass
`drill`	`/api/projects/:projectId/export/gerber`	Excellon `.drl` (included in Gerber ZIP)	Drill file included automatically with the Gerber export
`pick-place`	`/api/projects/:projectId/export/pick-place`	centroid `.csv`	Pick-and-place file with component reference designators, centroids, rotation, and side
`netlist-kicad`	`/api/projects/:projectId/export/netlist`	`.net`	KiCad-format netlist. Set `netlistFormat: "kicad"` in the request body
`netlist-csv`	`/api/projects/:projectId/export/netlist`	`.csv`	Netlist in CSV format. Set `netlistFormat: "csv"` in the request body
`design-report`	`/api/projects/:projectId/export/report-pdf`	PDF	Full design report: component count, net summary, DRC results, simulation results, FMEA, and metadata
`fmea`	`/api/projects/:projectId/export/fmea`	`.csv` (FMEA PDF is included in design report)	Failure Mode and Effects Analysis data exported as CSV
`firmware`	`/api/projects/:projectId/export/firmware`	`.zip`	Arduino / PlatformIO firmware scaffold generated from component types and properties in your design
`fritzing`	`/api/projects/:projectId/export/fzz`	`.fzz`	Fritzing project file, including breadboard and schematic views
`pdf`	`/api/projects/:projectId/export/pdf`	`.pdf`	Schematic or view exported as a PDF or SVG

The drill file (Excellon .drl) is bundled inside the Gerber ZIP — it is not a separate endpoint. When you call the gerber export, you receive a single ZIP containing all layer files and the drill file.

Request body parameters

All export endpoints accept a JSON body. Parameters vary by format; the table below describes all recognised fields.

bomFormat

string

default:"generic"

BOM CSV format variant. One of generic, jlcpcb, mouser, or digikey. Only applies to the bom-csv export.

includeHeader

boolean

default:"true"

Include a header row in BOM CSV output.

groupByPartNumber

boolean

default:"false"

Collapse duplicate part numbers in BOM CSV and sum quantities.

netlistFormat

string

default:"csv"

Netlist output format. One of spice, kicad, or csv. Only applies to the netlist export.

boardWidth

number

PCB board width in millimetres. Used by the Gerber generator to set the board outline. Defaults to the server constant DEFAULT_BOARD_WIDTH.

boardHeight

number

PCB board height in millimetres. Used by the Gerber generator to set the board outline. Defaults to DEFAULT_BOARD_HEIGHT.

viewData

object

Serialised view state for the PDF schematic export. Passed directly to the PDF generator.

paperSize

string

default:"A4"

Paper size for PDF export: A4, A3, Letter.

scale

number

default:"1.0"

Scale factor for PDF schematic export.

titleBlock

boolean

default:"true"

Include a title block with project name and date in the PDF export.

analysisType

string

SPICE analysis type for the .cir netlist export: op, tran, ac, or dc.

Response

All export endpoints return the generated file as the response body. Headers are set to trigger a browser download:

Content-Type: <format-specific MIME type>
Content-Disposition: attachment; filename="<generated-filename>"

Format	Content-Type
`kicad`, `gerber`, `firmware`, `fritzing`	`application/zip`
`bom-csv`, `pick-place`, `netlist-csv`, `fmea`	`text/csv`
`spice`, `netlist-kicad`	`text/plain`
`eagle`	`application/zip`
`design-report`, `pdf`	`application/pdf`

To save the file with curl, use the -o or -J -O flags:

curl -X POST http://localhost:5000/api/projects/1/export/gerber \
  -H "X-Session-Id: $SESSION" \
  -H "Content-Type: application/json" \
  -d '{"boardWidth": 50, "boardHeight": 40}' \
  -o gerbers.zip

DRC gate

Certain export formats run a Design Rule Check before generating output. If the DRC gate finds violations, the server returns 422 Unprocessable Entity with a JSON body listing the violations instead of the file.

Format	DRC gate
`gerber`	Yes — blocks export on any DRC error
`kicad`	No
`eagle`	No
`spice`	No
`design-report`	No (DRC results are included in the report regardless)
All others	No

{
  "message": "DRC gate failed — resolve errors before exporting",
  "violations": [
    {
      "severity": "error",
      "rule": "min-clearance",
      "message": "Trace clearance violation between net VCC and net GND at (120, 80)"
    }
  ]
}

Gerber files sent to a PCB fabricator must pass DRC. If you need to bypass the gate during development you can pass --ignore-drc in your local curl call, but this flag is not available on production deployments.

Format-specific examples

Generate Gerber + drill files for a 50×40 mm board:

curl -X POST http://localhost:5000/api/projects/1/export/gerber \
  -H "X-Session-Id: $SESSION" \
  -H "Content-Type: application/json" \
  -d '{"boardWidth": 50, "boardHeight": 40}' \
  -o gerbers.zip

The ZIP contains the following files:

File	Layer
`front-copper.gbr`	F.Cu — top copper
`back-copper.gbr`	B.Cu — bottom copper
`front-mask.gbr`	F.Mask — top solder mask
`back-mask.gbr`	B.Mask — bottom solder mask
`front-silkscreen.gbr`	F.SilkS — top silkscreen
`back-silkscreen.gbr`	B.SilkS — bottom silkscreen
`front-paste.gbr`	F.Paste — top solder paste
`drill.drl`	Excellon drill file

Export a KiCad project:

curl -X POST http://localhost:5000/api/projects/1/export/kicad \
  -H "X-Session-Id: $SESSION" \
  -H "Content-Type: application/json" \
  -d '{}' \
  -o project-kicad.zip

The ZIP contains schematic.kicad_sch, layout.kicad_pcb, and project.kicad_pro.

Export a JLCPCB-formatted BOM CSV:

curl -X POST http://localhost:5000/api/projects/1/export/bom \
  -H "X-Session-Id: $SESSION" \
  -H "Content-Type: application/json" \
  -d '{"bomFormat": "jlcpcb", "groupByPartNumber": true}' \
  -o bom-jlcpcb.csv

Export a SPICE netlist for transient analysis:

curl -X POST http://localhost:5000/api/projects/1/export/spice \
  -H "X-Session-Id: $SESSION" \
  -H "Content-Type: application/json" \
  -d '{"analysisType": "tran"}' \
  -o circuit.cir

Export a centroid CSV for assembly:

curl -X POST http://localhost:5000/api/projects/1/export/pick-place \
  -H "X-Session-Id: $SESSION" \
  -H "Content-Type: application/json" \
  -d '{}' \
  -o pick-place.csv

The CSV contains columns: Reference, Value, Package, PosX, PosY, Rotation, Side.

Generate a firmware scaffold:

curl -X POST http://localhost:5000/api/projects/1/export/firmware \
  -H "X-Session-Id: $SESSION" \
  -H "Content-Type: application/json" \
  -d '{}' \
  -o firmware-scaffold.zip

The ZIP contains a PlatformIO project with stub setup() and loop() functions, #include directives for detected IC families, and pin definitions derived from your schematic.

Triggering exports via the AI assistant

You can ask the AI assistant to generate any supported export format using natural language. The AI calls the trigger_export, generate_gerber, or generate_kicad tools from the export tool module. Example prompts:

“Export this design as Gerber files”
“Generate a JLCPCB BOM CSV”
“Download the KiCad project”
“Create a PDF design report”

The AI validates your request, checks DRC status if required, calls the appropriate export endpoint, and provides a download link in the chat panel.

Before triggering a Gerber export via the AI, ask it to “run ERC and DRC on this design” first. The AI will surface any violations and offer to fix them before attempting the export.

Setup & Architecture

API Reference

Contributing

Export API — Generate Manufacturing Files

Supported formats

Request body parameters

Response

DRC gate

Format-specific examples

Triggering exports via the AI assistant

Build docs developers (and LLMs) love

Setup & Architecture

API Reference

Contributing

Documentation Index

​Supported formats

​Request body parameters

​Response

​DRC gate

​Format-specific examples

​Triggering exports via the AI assistant

Build docs developers (and LLMs) love

Supported formats

Request body parameters

Response

DRC gate

Format-specific examples

Triggering exports via the AI assistant