Skip to main content
POST
Upload a BOM file

Authorizations

Authorization
string
header
required

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

Idempotency-Key
string

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

multipart/form-data
file
file
required

The BOM, as .csv or .xlsx.

name
string

A label for this BOM. Defaults to the file name.

Response

Accepted. Analysis has started.

as_of
string<date-time>
required

ISO 8601. How current the data in this response is.

summary
string
required

Plain language an agent can relay without re-deriving it.

notice
string
required

Informational-use notice. Always present.

bom
object
required