Skip to main content
POST
Check a design

Authorizations

X-API-Key
string
header
required

Your ProvenMetal API key (pm_live_...). Authorization: Bearer <key> also works.

Body

application/json
upload_id
string
required

The upload_id from POST /v1/uploads.

Maximum string length: 64
boards
integer | null

How many boards will be built, to check the BOM's parts.

Required range: 1 <= x <= 100000
copper_oz
number | null

Outer copper weight in oz; JLCPCB's standard 1 oz if left out.

Required range: 0.5 <= x <= 6
thickness_mm
number | null

Finished thickness in mm; JLCPCB's standard 1.6 mm if left out.

Required range: 0.2 <= x <= 6
board
string | null

Which .kicad_pcb to check when the upload holds more than one.

wait_s
integer
default:15

Seconds to wait for the distributors' answer. 0 returns JLCPCB's answer at once (about two seconds); the default covers most boards.

Required range: 0 <= x <= 50
itar
boolean
default:false

true if the design is ITAR-controlled: it is refused before anything is read.

Response

Successful Response

ok
boolean
required
status
enum<string>
required

checking: a large board's copper is still being measured; findings are those so far. Send the same check again after retry_after_s.

Available options:
pass,
warning,
must_fix,
checking
findings
Findings · object[]
required

Worst first: {level (must_fix, warning, note), check, what}.

fabricators
Fabricators · object[]
required

Each partner fab's estimated verdict from its published limits: can_build, cannot_build or not_fully_checked.

retry_after_s
integer | null

With checking: seconds until the full report. Also in the Retry-After header.

board_check
Board Check · object | null

With checking: the board check still running, and where it is.

files
Files · object[] | null
assumed
string[] | null
more_findings
integer | null
fabricators_note
string | null
parts
Parts · object | null

With boards: the BOM's parts, as POST /v1/part-checks answers.

part_checks
Part Checks · object | null

With a BOM: datasheet, package and footprint checks, on a later call.