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

# Introduction

> Read your complete Amber catalog and business records through one API

Use the Amber Public API to read your brand's catalog, sourcing, purchasing,
logistics, finance, partners, documents, and reference libraries. Business
endpoints are read-only and require an API key. Each request reads one brand.

## Make your first request

Ask your Amber system administrator for an API key and your brand slug.
Set `AMBER_API_KEY` and `AMBER_BRAND` in your server environment, then run:

```bash theme={null}
curl --fail-with-body \
  -H "Authorization: Bearer $AMBER_API_KEY" \
  "https://app.amber.ai/api/public/v1/brands/$AMBER_BRAND"
```

The response identifies the authorized brand, even when its catalog is empty:

```json theme={null}
{"id":"00000000-0000-4000-8000-000000000001","slug":"acme","name":"Acme"}
```

Use the returned `id` for brand relationships and document subjects; use `slug`
in request paths. Then read `/brands/{brand}/products?limit=25`. Collections
return `items`, `nextCursor`, and `totalItems`, with a `Link` header when there
is another page. The base URL is
`https://app.amber.ai/api/public/v1`. The [OpenAPI specification](https://app.amber.ai/api/public/v1/openapi.json)
is the source for the API Reference tab and client generation.

The brand is the slug from your Amber URL, for example `acme` in `/b/acme`.
Use the key's authorized brand. A successful first request returns HTTP `200`;
this check does not need any existing products or orders.
If you receive `401`, check the key and brand with your administrator. See
[Authentication](/authentication) for access and rate limits.

## Build an integration

Choose a tutorial based on the result you need. Each includes runnable Node.js
examples and explains how to retrieve records beyond the first page.

| Your goal | Tutorial |
| - | - |
| Populate an ERP, PIM, or warehouse with products and sellable variations | [Export Parent Products, Product Options, and SKUs](/tutorials/export-catalog) |
| Assemble specifications with versions, BOMs, measurements, and related data | [Read a complete product graph](/tutorials/product-specifications) |
| Compare supplier offers by revision, SKU, quantity, and currency | [Compare quotes and price breaks](/tutorials/compare-quotes) |
| Follow purchase orders through production, shipments, receipts, and payments | [Track orders and fulfillment](/tutorials/track-orders) |
| Retrieve product files or supplier documents attached to an order | [Download documents and images](/tutorials/download-documents) |

## Find the data you need

| Area | Resources |
| - | - |
| Catalog | Parent Products, Product Options, SKUs, versions, BOMs, components, measurement tables, assignments, images |
| Sourcing and purchasing | Quotes, quote revisions/items/price bands, samples and rounds, orders/items/amendments, production runs and revisions |
| Logistics | Shipments/items/cartons/charges, legs, bookings, packing lists, allocations, inventory, goods receipts |
| Finance | Payment agreements, milestones, obligations, settlements, receipts, invoices and lines |
| Partners and shared data | Partners, Suppliers, contacts, locations, documents, notes, custom fields and reference libraries |

Start with [Product graphs](/product-graphs), [Entity relationships](/entity-relationships),
and [Pagination and errors](/pagination). Every collection's filters and exact
response fields appear in the API Reference tab.

For AI assistants and automation platforms that speak MCP, see
[Model Context Protocol (MCP)](/guides/mcp). API-key MCP is available on the
deployed API; browser OAuth connectors are documented there when they ship.

Find known records with [business identifier lookups](/tutorials/find-records),
then use direct Quote navigation or `productGraph()` to retrieve their related data.


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