Skip to main content
POST
Compare parts

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 comparison, and send the same value again only when retrying that same comparison after a timeout. A retry with the same key returns the comparison the first call started and starts no second one. A key is recognised only from the same API key that sent it. Optional.

Body

application/json
parts
object[]

Your own list: 2 to 6 parts, compared as given. The first is the reference the others are compared with. Send this or mpn, not both.

Required array length: 2 - 6 elements
mpn
string

One part, compared with its alternates (the list GET /v1/alternates returns). If the part has no alternates, the comparison still completes, with this part alone and no columns. To compare parts you name with each other, send them all in parts instead. Send this or parts, not both.

Minimum string length: 1
manufacturer
string

The maker of mpn. Only needed when several companies make a part with this number.

Minimum string length: 1

Response

Accepted. The comparison has started; a retry with an Idempotency-Key already used returns the comparison that key started, with its current status.

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.

id
string<uuid>
required

Poll GET /v1/compare/{id} with it.

status
enum<string>
required

processing for a new comparison. A retry with an Idempotency-Key already used returns the comparison that key started, with its current status.

Available options:
processing,
complete,
failed