Skip to main content
POST
Create a buy link

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
project_name
string
required

The board's name, shown to shoppers.

Maximum string length: 200
source_url
string | null

The board's page.

Maximum string length: 2000
assembly
boolean
default:false

true if the board can be ordered assembled.

layers
integer | null
thickness_mm
number | null
surface_finish
string | null
solder_mask
string | null
copper_oz
integer | null
material
string | null
board
string | null
skip_board_checks
boolean
default:false
itar
boolean
default:false

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

Response

Successful Response

ok
boolean
required
buy_url
string
required
notes
string[] | null