curl --request POST \
--url https://api.provenmetal.com/v1/design-checks \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"upload_id": "<string>",
"boards": 50000,
"copper_oz": 3.25,
"thickness_mm": 3.1,
"board": "<string>",
"wait_s": 15,
"itar": false
}
'import requests
url = "https://api.provenmetal.com/v1/design-checks"
payload = {
"upload_id": "<string>",
"boards": 50000,
"copper_oz": 3.25,
"thickness_mm": 3.1,
"board": "<string>",
"wait_s": 15,
"itar": False
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
upload_id: '<string>',
boards: 50000,
copper_oz: 3.25,
thickness_mm: 3.1,
board: '<string>',
wait_s: 15,
itar: false
})
};
fetch('https://api.provenmetal.com/v1/design-checks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.provenmetal.com/v1/design-checks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'upload_id' => '<string>',
'boards' => 50000,
'copper_oz' => 3.25,
'thickness_mm' => 3.1,
'board' => '<string>',
'wait_s' => 15,
'itar' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.provenmetal.com/v1/design-checks"
payload := strings.NewReader("{\n \"upload_id\": \"<string>\",\n \"boards\": 50000,\n \"copper_oz\": 3.25,\n \"thickness_mm\": 3.1,\n \"board\": \"<string>\",\n \"wait_s\": 15,\n \"itar\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.provenmetal.com/v1/design-checks")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"upload_id\": \"<string>\",\n \"boards\": 50000,\n \"copper_oz\": 3.25,\n \"thickness_mm\": 3.1,\n \"board\": \"<string>\",\n \"wait_s\": 15,\n \"itar\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.provenmetal.com/v1/design-checks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"upload_id\": \"<string>\",\n \"boards\": 50000,\n \"copper_oz\": 3.25,\n \"thickness_mm\": 3.1,\n \"board\": \"<string>\",\n \"wait_s\": 15,\n \"itar\": false\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"status": "pass",
"findings": [
{}
],
"fabricators": [
{}
],
"retry_after_s": 123,
"board_check": {},
"files": [
{}
],
"assumed": [
"<string>"
],
"more_findings": 123,
"fabricators_note": "<string>",
"parts": {},
"part_checks": {}
}{
"error": "<string>",
"message": "<string>",
"ok": false,
"questions": [
{}
],
"known": {},
"parts": [
{}
],
"off_board_parts": [
{}
],
"retry_after_s": 123,
"checkout_url": "<string>",
"fields": [
{}
]
}{
"error": "<string>",
"message": "<string>",
"ok": false,
"questions": [
{}
],
"known": {},
"parts": [
{}
],
"off_board_parts": [
{}
],
"retry_after_s": 123,
"checkout_url": "<string>",
"fields": [
{}
]
}{
"error": "<string>",
"message": "<string>",
"ok": false,
"questions": [
{}
],
"known": {},
"parts": [
{}
],
"off_board_parts": [
{}
],
"retry_after_s": 123,
"checkout_url": "<string>",
"fields": [
{}
]
}Check a design
An uploaded board checked the way a fab would, with no quote or order: JLCPCB’s limits, each partner fab’s estimated verdict, KiCad’s own design-rule check, and with boards the BOM’s parts. The fab verdicts are an estimate from published limits, not the fab’s review. 120 an hour per key.
curl --request POST \
--url https://api.provenmetal.com/v1/design-checks \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"upload_id": "<string>",
"boards": 50000,
"copper_oz": 3.25,
"thickness_mm": 3.1,
"board": "<string>",
"wait_s": 15,
"itar": false
}
'import requests
url = "https://api.provenmetal.com/v1/design-checks"
payload = {
"upload_id": "<string>",
"boards": 50000,
"copper_oz": 3.25,
"thickness_mm": 3.1,
"board": "<string>",
"wait_s": 15,
"itar": False
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
upload_id: '<string>',
boards: 50000,
copper_oz: 3.25,
thickness_mm: 3.1,
board: '<string>',
wait_s: 15,
itar: false
})
};
fetch('https://api.provenmetal.com/v1/design-checks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.provenmetal.com/v1/design-checks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'upload_id' => '<string>',
'boards' => 50000,
'copper_oz' => 3.25,
'thickness_mm' => 3.1,
'board' => '<string>',
'wait_s' => 15,
'itar' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.provenmetal.com/v1/design-checks"
payload := strings.NewReader("{\n \"upload_id\": \"<string>\",\n \"boards\": 50000,\n \"copper_oz\": 3.25,\n \"thickness_mm\": 3.1,\n \"board\": \"<string>\",\n \"wait_s\": 15,\n \"itar\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.provenmetal.com/v1/design-checks")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"upload_id\": \"<string>\",\n \"boards\": 50000,\n \"copper_oz\": 3.25,\n \"thickness_mm\": 3.1,\n \"board\": \"<string>\",\n \"wait_s\": 15,\n \"itar\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.provenmetal.com/v1/design-checks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"upload_id\": \"<string>\",\n \"boards\": 50000,\n \"copper_oz\": 3.25,\n \"thickness_mm\": 3.1,\n \"board\": \"<string>\",\n \"wait_s\": 15,\n \"itar\": false\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"status": "pass",
"findings": [
{}
],
"fabricators": [
{}
],
"retry_after_s": 123,
"board_check": {},
"files": [
{}
],
"assumed": [
"<string>"
],
"more_findings": 123,
"fabricators_note": "<string>",
"parts": {},
"part_checks": {}
}{
"error": "<string>",
"message": "<string>",
"ok": false,
"questions": [
{}
],
"known": {},
"parts": [
{}
],
"off_board_parts": [
{}
],
"retry_after_s": 123,
"checkout_url": "<string>",
"fields": [
{}
]
}{
"error": "<string>",
"message": "<string>",
"ok": false,
"questions": [
{}
],
"known": {},
"parts": [
{}
],
"off_board_parts": [
{}
],
"retry_after_s": 123,
"checkout_url": "<string>",
"fields": [
{}
]
}{
"error": "<string>",
"message": "<string>",
"ok": false,
"questions": [
{}
],
"known": {},
"parts": [
{}
],
"off_board_parts": [
{}
],
"retry_after_s": 123,
"checkout_url": "<string>",
"fields": [
{}
]
}Authorizations
Your ProvenMetal API key (pm_live_...). Authorization: Bearer <key> also works.
Body
The upload_id from POST /v1/uploads.
64How many boards will be built, to check the BOM's parts.
1 <= x <= 100000Outer copper weight in oz; JLCPCB's standard 1 oz if left out.
0.5 <= x <= 6Finished thickness in mm; JLCPCB's standard 1.6 mm if left out.
0.2 <= x <= 6Which .kicad_pcb to check when the upload holds more than one.
Seconds to wait for the distributors' answer. 0 returns JLCPCB's answer at once (about two seconds); the default covers most boards.
0 <= x <= 50true if the design is ITAR-controlled: it is refused before anything is read.
Response
Successful Response
checking: a large board's copper is still being measured; findings are those so far. Send the same check again after retry_after_s.
pass, warning, must_fix, checking Worst first: {level (must_fix, warning, note), check, what}.
Each partner fab's estimated verdict from its published limits: can_build, cannot_build or not_fully_checked.
With checking: seconds until the full report. Also in the Retry-After header.
With checking: the board check still running, and where it is.
With boards: the BOM's parts, as POST /v1/part-checks answers.
With a BOM: datasheet, package and footprint checks, on a later call.