Quickstart

This guide walks you through uploading a schematic file, running your first review, and reading the violation report. The entire flow takes under 10 minutes on a first-time setup.

You need a CADY account to follow this guide. The Free tier allows 3 reviews per month at no cost. Create an account before continuing.

1. Supported file formats

CADY accepts the following input formats for netlist and BOM review:

KiCad: .kicad_sch, .net (netlist export)
Altium Designer: .SchDoc, exported netlist .NET
Autodesk Eagle: .sch, .brd
SPICE: raw .cir or .sp netlists
BOM CSV: any CSV with columns Reference, Value, Footprint

2. Run a review via the web UI

After logging in, click New Review in the dashboard sidebar. The review panel opens on the right.

Upload your schematic or netlist file

Drag your file onto the upload target or click to browse. CADY detects the format automatically. Maximum file size is 50 MB. You can optionally attach a BOM CSV alongside the schematic to enable BOM cross-check rules.

Choose your rule profile

Select Standard for the default 870+ rule set, or choose Custom if your team has already defined a rule profile in Settings. Free and Starter accounts use Standard only.

Click Run Review and wait for results

A typical 200-component schematic completes in under 2 minutes. You will see a live progress bar. Results appear in the same panel when the engine finishes.

Read the violation report

Violations are grouped by severity: CRIT, WARN, and INFO. Each entry shows the rule ID, the affected net or component, and a plain-English explanation. Click any row to jump to the rule documentation.

3. Run a review via the REST API

For CI/CD pipelines or automated EDA toolchains, use the API directly. Your API key is available in Settings > API Keys.

curl -X POST https://api.cadysoiutions.com/v1/reviews \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: multipart/form-data" \
  -F "[email protected]_sch" \
  -F "profile=standard"

The response returns a review_id. Poll GET /v1/reviews/{id} until status is complete, then fetch the full report from GET /v1/reviews/{id}/report.

{
  "review_id": "rvw_01HQZP8KNVB3X6YAF2D7WTCM4E",
  "status": "complete",
  "violation_count": {
    "crit": 2,
    "warn": 2,
    "info": 1,
    "pass": 843
  },
  "created_at": "2026-04-14T09:17:43Z",
  "completed_at": "2026-04-14T09:19:25Z"
}

4. Export results

Download the report in any supported format from the dashboard or via the API:

GET /v1/reviews/{id}/report?format=pdf for annotated PDF
GET /v1/reviews/{id}/report?format=json for machine-readable JSON
GET /v1/reviews/{id}/report?format=csv for spreadsheet import