Skip to main content
POST
Search for 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 search, and send the same value again only when retrying that same search after a timeout. A retry with the same key returns the search 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
query
string
required

What to search for: a part number, or a description of the part ("3A buck converter 28V", "6205 bearing").

Minimum string length: 1

Response

Accepted. The search has started; a retry with an Idempotency-Key already used returns the search 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/search/{id} with it.

status
enum<string>
required

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

Available options:
processing,
complete,
failed