Upload a BOM file
Submit a bill of materials as a CSV or XLSX file. We find the part-number column and the other columns we recognise (manufacturer, quantity, supplier, description, and more), then run the same analysis as POST /v1/bom: the call answers 202 with the BOM id and GET /v1/bom/{id} carries the report. One file carries up to 2,000 rows. A request body over 4.5 MB is refused with 413.
curl --request POST \
--url https://api.partfinder.dev/v1/bom/upload \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form file=@example-file \
--form 'name=<string>'import requests
url = "https://api.partfinder.dev/v1/bom/upload"
files = { "file": ("example-file", open("example-file", "rb")) }
payload = { "name": "<string>" }
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('file', '<string>');
form.append('name', '<string>');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://api.partfinder.dev/v1/bom/upload', 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.partfinder.dev/v1/bom/upload",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data"
],
]);
$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.partfinder.dev/v1/bom/upload"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.partfinder.dev/v1/bom/upload")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.partfinder.dev/v1/bom/upload")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n<string>\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"as_of": "2026-09-28T15:49:42.444Z",
"summary": "Accepted 3 lines. The BOM is being analyzed; poll GET /v1/bom/fc2b3371-7eb7-48cd-8847-70b2d76b0be8 until status is \"complete\".",
"notice": "Informational only. Risk scores, stock levels, lead times and alternate-part suggestions may be incomplete, delayed or inaccurate. Independently verify before making procurement, engineering, compliance, safety or sourcing decisions.",
"bom": {
"id": "fc2b3371-7eb7-48cd-8847-70b2d76b0be8",
"name": "Controller board rev C",
"status": "processing",
"lines": 3,
"created_at": "2026-09-28T15:49:38.809Z"
}
}{
"error": "authentication_required",
"summary": "<string>",
"reason": "<string>",
"billing_url": "<string>",
"did_you_mean": [
"<string>"
]
}{
"error": "authentication_required",
"summary": "<string>",
"reason": "<string>",
"billing_url": "<string>",
"did_you_mean": [
"<string>"
]
}{
"error": "credits_exhausted",
"summary": "Your organization's credits for this month are used up, so this request was not run. Upgrade your plan in the PartFinder console at https://console.partfinder.dev/settings/billing, then try again.",
"reason": "This request needs 75 credits and 0 are left.",
"billing_url": "https://console.partfinder.dev/settings/billing"
}{
"error": "authentication_required",
"summary": "<string>",
"reason": "<string>",
"billing_url": "<string>",
"did_you_mean": [
"<string>"
]
}{
"error": "authentication_required",
"summary": "<string>",
"reason": "<string>",
"billing_url": "<string>",
"did_you_mean": [
"<string>"
]
}{
"error": "authentication_required",
"summary": "<string>",
"reason": "<string>",
"billing_url": "<string>",
"did_you_mean": [
"<string>"
]
}{
"error": "authentication_required",
"summary": "<string>",
"reason": "<string>",
"billing_url": "<string>",
"did_you_mean": [
"<string>"
]
}Authorizations
An API key created in the PartFinder console at https://console.partfinder.dev, or a customer key created with POST /v1/keys. Send as Authorization: Bearer <key>. Revocation takes effect within approximately one minute.
Headers
Set by your client code, not by a person or a model: generate a new value (a UUID) for each submission, and send the same value again only when retrying that same request after a timeout. A retry with the same key returns the BOM the first request created instead of a duplicate. A key is recognised only from the same API key that sent it. The body is not compared, so never reuse a key for a different or updated BOM. A key is remembered for as long as the BOM it created exists; after that BOM is deleted, the same key starts a new one. Optional.
Body
Response
Accepted. Analysis has started.
Was this page helpful?
curl --request POST \
--url https://api.partfinder.dev/v1/bom/upload \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form file=@example-file \
--form 'name=<string>'import requests
url = "https://api.partfinder.dev/v1/bom/upload"
files = { "file": ("example-file", open("example-file", "rb")) }
payload = { "name": "<string>" }
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('file', '<string>');
form.append('name', '<string>');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://api.partfinder.dev/v1/bom/upload', 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.partfinder.dev/v1/bom/upload",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data"
],
]);
$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.partfinder.dev/v1/bom/upload"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.partfinder.dev/v1/bom/upload")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.partfinder.dev/v1/bom/upload")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n<string>\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"as_of": "2026-09-28T15:49:42.444Z",
"summary": "Accepted 3 lines. The BOM is being analyzed; poll GET /v1/bom/fc2b3371-7eb7-48cd-8847-70b2d76b0be8 until status is \"complete\".",
"notice": "Informational only. Risk scores, stock levels, lead times and alternate-part suggestions may be incomplete, delayed or inaccurate. Independently verify before making procurement, engineering, compliance, safety or sourcing decisions.",
"bom": {
"id": "fc2b3371-7eb7-48cd-8847-70b2d76b0be8",
"name": "Controller board rev C",
"status": "processing",
"lines": 3,
"created_at": "2026-09-28T15:49:38.809Z"
}
}{
"error": "authentication_required",
"summary": "<string>",
"reason": "<string>",
"billing_url": "<string>",
"did_you_mean": [
"<string>"
]
}{
"error": "authentication_required",
"summary": "<string>",
"reason": "<string>",
"billing_url": "<string>",
"did_you_mean": [
"<string>"
]
}{
"error": "credits_exhausted",
"summary": "Your organization's credits for this month are used up, so this request was not run. Upgrade your plan in the PartFinder console at https://console.partfinder.dev/settings/billing, then try again.",
"reason": "This request needs 75 credits and 0 are left.",
"billing_url": "https://console.partfinder.dev/settings/billing"
}{
"error": "authentication_required",
"summary": "<string>",
"reason": "<string>",
"billing_url": "<string>",
"did_you_mean": [
"<string>"
]
}{
"error": "authentication_required",
"summary": "<string>",
"reason": "<string>",
"billing_url": "<string>",
"did_you_mean": [
"<string>"
]
}{
"error": "authentication_required",
"summary": "<string>",
"reason": "<string>",
"billing_url": "<string>",
"did_you_mean": [
"<string>"
]
}{
"error": "authentication_required",
"summary": "<string>",
"reason": "<string>",
"billing_url": "<string>",
"did_you_mean": [
"<string>"
]
}