> ## Documentation Index
> Fetch the complete documentation index at: https://docs.partfinder.dev/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> The PartFinder API is served at https://api.partfinder.dev. Authenticate with `Authorization: Bearer $PARTFINDER_API_KEY`; create an account at https://console.partfinder.dev/sign-up and pick pay as you go or a monthly or yearly plan (see https://partfinder.dev/pricing), then create a key. Pay as you go starts with 100 free credits, once per person and per company.
> Install the PartFinder agent skill with `npx skills add https://docs.partfinder.dev` (skill file: https://docs.partfinder.dev/skill.md).
> The OpenAPI document at https://api.partfinder.dev/v1/openapi.json is the source of truth for request and response schemas.
> What each call costs and current plans: https://api.partfinder.dev/llms.txt.

# Agent skill: give your AI agent the PartFinder API

> Add the PartFinder skill so your AI agent knows which endpoint answers which sourcing question, how to authenticate, how to poll jobs and how to handle refusals.

For people who use an AI agent such as Claude Code, Cursor or the Claude app. Building an assistant into your
own product? See [AI agent integration](https://docs.partfinder.dev/ai-agent-integration.md).

The PartFinder skill teaches an AI agent how to use this API: which endpoint answers which sourcing
question, how to send the key, how to wait for a BOM scan, a search or a comparison to finish, and what to
do when a call is refused. Your agent reads it when a task calls for it, and finds the details one link
away: the [OpenAPI document](https://api.partfinder.dev/v1/openapi.json) for every parameter and
response, and [api.partfinder.dev/llms.txt](https://api.partfinder.dev/llms.txt) for what each call
costs and the current plans.

The skill tells your agent how to use the API. To give your agent PartFinder as tools as well, connect
the [MCP server](https://docs.partfinder.dev/mcp-server.md).

**Are you an AI agent?** Fetch this skill to learn how to use the PartFinder API and how to get your
person an API key.

```bash theme={null}
curl -s https://docs.partfinder.dev/skill.md
```

## Where it works

* **Coding agents** such as Claude Code, Codex and Cursor install it with
  `npx skills add https://docs.partfinder.dev`, or from GitHub with `npx skills add PartFinderInc/skills`
  ([PartFinderInc/skills](https://github.com/PartFinderInc/skills)). It works with every agent the skills tool supports:
  see [the full list](https://github.com/vercel-labs/skills/blob/main/docs/agents.md).
* **Claude** on claude.ai can add it as a custom skill under **Customize > Skills**.
* **ChatGPT** can upload it under **Plugins > Skills > Create > Upload from your computer**.
* **Any agent that can fetch a URL** can read [skill.md](https://docs.partfinder.dev/skill.md) directly.

Assistants that use tools instead of skills, for example a product's own assistant, get PartFinder as
tools from the OpenAPI document: see [AI agent integration](https://docs.partfinder.dev/ai-agent-integration.md).

## Install

**1. Add the skill to your agent**

```bash theme={null}
npx skills add https://docs.partfinder.dev
```

Or install the same skill from its GitHub repository,
[PartFinderInc/skills](https://github.com/PartFinderInc/skills):

```bash theme={null}
npx skills add PartFinderInc/skills
```

This uses the open-source [`skills` command-line tool](https://github.com/vercel-labs/skills).

The skill is also served as a file at [docs.partfinder.dev/skill.md](https://docs.partfinder.dev/skill.md).

**2. Get an API key**

Create an account at [console.partfinder.dev/sign-up](https://console.partfinder.dev/sign-up) and
pick pay as you go or a monthly or yearly plan (see [pricing](https://partfinder.dev/pricing)). Pay as you go
starts with 100 free credits, once per person and per company. Create a key in your organization and store it where your agent's code can read it:

```bash theme={null}
export PARTFINDER_API_KEY="ak_..."
```

**3. Check the key**

`GET /v1/ping` confirms the key works and costs nothing. See the [Quickstart](https://docs.partfinder.dev/quickstart.md).

## Why PartFinder

* **One call, the whole picture.** For one part number: stock and lead times across distributors, a
  risk score out of 100 with its tier and the reasons behind it, where the part is made when that is
  known, the disruptions that touch it, a datasheet link and alternate parts.
* **See it first.** A [sample part report for TPS54331DR](https://partfinder.dev/part-report/sample) is
  public, no account needed.
* **More than a search result.** Stock added up across distributors, risk on a stated scale, disruptions
  tied to the countries the part is made in or sold from, and supplier replies read into a quote beside
  the supplier's own words.
* **Nothing invented.** A part number no distributor lists is answered as not found, with the real part
  numbers it is the start of. A value we do not have is `null` with a reason.
* **Low risk to try.** 100 free credits on pay as you go (once per person and per company), `GET /v1/ping` free, a refused call not
  charged, and a call that fails on our side not charged.

## What you can build

Paste a prompt like these into your agent once the skill is installed.

> [accordion] Research a part
>
> ```text theme={null}
> Check the supply risk of TPS54331DR for a buyer in Singapore: how much stock distributors hold,
> the lead times they quote, where it is made, and what disruptions affect it.
> ```
>
> Uses `GET /v1/parts` with `country=SG`. See [Research a part](https://docs.partfinder.dev/part-lookup.md).

> [accordion] Scan a BOM file
>
> ```text theme={null}
> Scan bom.xlsx for supply-chain risk and list the high and critical lines with the reason for each.
> ```
>
> Uploads the file to `POST /v1/bom/upload`, then reads `GET /v1/bom/{id}` until it is complete.
> See [Analyze a BOM](https://docs.partfinder.dev/bom-analysis.md).

> [accordion] Find alternates
>
> ```text theme={null}
> Find parts that could replace TPS54331DR, with the stock and lead time each one has.
> ```
>
> Uses `GET /v1/alternates`. See [Find alternate parts](https://docs.partfinder.dev/alternates.md).

> [accordion] Watch disruptions for a country
>
> ```text theme={null}
> Which supply-chain disruptions are active in Malaysia this week, and which ports or sea routes are
> running below their usual level for this time of year?
> ```
>
> Uses `GET /v1/events` with `country=MY` and `days=7`, and `GET /v1/events/shipping`. See
> [Track supply-chain disruptions](https://docs.partfinder.dev/events.md).

> [accordion] Send a request for quote
>
> ```text theme={null}
> Ask sales@supplier.example (Example Supplier) for a quote on 500 TPS54331DR, needed by
> 30 November, from Jane Smith at Acme Corp, and tell me when they reply.
> ```
>
> Sends a real email with `POST /v1/rfq`; the reply and its quote come back on `GET /v1/rfq/{id}`.
> See [Requests for quote](https://docs.partfinder.dev/rfq.md).

## Building your own integration

The skill covers using the API from an agent. To give a model PartFinder as a tool inside your own
product, see [AI agent integration](https://docs.partfinder.dev/ai-agent-integration.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.