Key management
Create your first key through Amber settings, using a system administrator account. You do not need an existing API key. Copy the new key when it is shown; you cannot retrieve its secret again from the key list. Manage and rotate keys in Amber settings while signed in as a system administrator. An API key cannot create or manage other keys. Rotation immediately revokes the old key, so update your integration with the replacement. All business endpoints in the API Reference are read-only. You can browse the documentation and download the OpenAPI specification without a key.Access failures and limits
Missing, invalid, expired, revoked, and out-of-scope keys return401.
A valid key requesting an unavailable entity receives 404.
Rate limiting is per key. A 429 response includes Retry-After in seconds.
See Pagination and errors for a retrying client example.
Product expansion has an additional budget shared by the key across brands.
Each distinct include collection costs one credit; include=all costs 31.
By default, you can use up to 62 expansion credits at once, enough for two
include=all requests. Credits replenish at 1,000 per hour; this rate can vary
with your key’s request limit. Expanded requests also count toward your regular
request limit.
On 429, wait for Retry-After before retrying. Request only the collections you
need to reduce credit use. Product reads without include and independent
collection pagination consume no expansion credits.
MCP (separate from REST)
The REST API at/api/public/v1 is API-key only and read-only. Nothing in
this page applies OAuth or browser session cookies to REST.
MCP uses its own URLs and credentials:
OAuth tokens work only with MCP, not with
/api/public/v1. Revoking an API
key does not disconnect an OAuth MCP client, and revoking OAuth does not revoke
keys. See Model Context Protocol (MCP) for discovery, consent,
and choosing a brand for OAuth tool calls.
