# API reference overview

> Every Build tool is one POST with a JSON body, the same fields on every platform, and an X-API-Key header.

> **Illustrative call shape**
>
> The host and path below come from the current plan. They are illustrative until the contract is final.

## How a call works

Each tool is one `POST` to `{tool name}` under the base URL, with one key in the `X-API-Key` header and a JSON body.

**Shape**

```bash
POST https://build-api.sellermate.ai/v1/tools/{name}
X-API-Key: $BUILD_API_KEY
Content-Type: application/json
```

Rows come back in the same fields on every platform. Every answer carries `data_as_of`. There is one live version, with `/v1` in the path, and breaking changes are announced in the [changelog](https://build.sellermate.ai/docs/changelog.md).

## Tools

- [get_campaign_performance](https://build.sellermate.ai/docs/api-reference/get-campaign-performance.md): Reads. Amazon and Google Ads. Spend, clicks, orders, sales and ACoS for each campaign over a date range, in the same fields on Amazon and Google Ads.
- [get_search_term_performance](https://build.sellermate.ai/docs/api-reference/get-search-term-performance.md): Reads. Amazon and Google Ads. Search terms with their clicks, spend and orders over a date range, on Amazon and Google Ads.
- [get_orders_report](https://build.sellermate.ai/docs/api-reference/get-orders-report.md): Reads. Amazon. Orders and units for an Amazon Seller account over a date range.
- [get_inventory](https://build.sellermate.ai/docs/api-reference/get-inventory.md): Reads. Amazon. Stock and inbound units for an Amazon account.
- [update_target](https://build.sellermate.ai/docs/api-reference/update-target.md): Writes on Amazon only. Amazon. Change a target on an Amazon Ads account, behind caps, a dry run and undo.

## Common to every tool

- Authentication: the `X-API-Key` header, a key scoped per account. See [Keys and scopes](https://build.sellermate.ai/docs/guides/keys-and-scopes.md).
- Limits: requests per minute by plan. See [Plans and limits](https://build.sellermate.ai/docs/guides/plans-and-limits.md).
- Writes: Amazon only. See [Writes and guardrails](https://build.sellermate.ai/docs/guides/writes-and-guardrails.md).

_To write: the full tool list: this page lists the five tools in the API reference so far. Add the rest, and link the OpenAPI file and Postman collection once they exist_