API Docs

Three calls: get a key, upload a catalog, resolve a query.

Get an API key — no sign-up required to try it. Generate one now → (or sign in for a key you can view again later from the dashboard.)

1. Get an API key

POST /api/register with an optional { name } body creates a workspace and returns your key. It is shown once — see Get an API key for a hosted form that does this for you.

curl -X POST https://partpin.net/api/register \
  -H "content-type: application/json" \
  -d '{"name":"Acme Bearing Supply"}'

# => { "orgId": "...", "apiKey": "pk_...", "next": "..." }

2. Upload your catalog

POST /api/catalog with either a catalog array or a raw feedCsv string. Each item needs at least id and sku; mpn, aliases, and title are optional.

curl -X POST https://partpin.net/api/catalog \
  -H "authorization: Bearer pk_..." \
  -H "content-type: application/json" \
  -d '{"catalog":[{"id":"1","sku":"6203-2RS","aliases":["6203DDU"]}]}'

3. Resolve a query

GET /api/v1/resolve — pass the query as q and your key either as ?key= or an Authorization: Bearer header. Results come back either asserted (deterministic, safe to act on) or as a ranked candidate (verify before using).

curl "https://partpin.net/api/v1/resolve?q=6203ddu&key=pk_..."

Other endpoints

GET /api/v1/queries?key=pk_... — recent resolve calls for your workspace; add &misses=1 for zero-result / unasserted-only queries.
POST /api/v1/confirm — { query, itemId }, records that a human confirmed a candidate match. It becomes an asserted alias next time.
POST /api/keys/rotate— dashboard-session only. Replaces your workspace’s API key; the old one stops working immediately.

Pricing

Sign-up, the dashboard, and catalog upload are free. See Pricing for the current status of paid usage.