Release Notes

Every change to the API, newest first. Each entry names the endpoint, field or scope it affects and links to the page that documents it. If a release is not listed here, it did not happen.

1.1.0

7 September 2026Current

No change to any request or response you already depend on. Internal-visibility scopes can now be granted on a key, and every endpoint, error and limit is documented with the release it appeared in.

AddedScopes businesses.internal.read, products.internal.read and businesses.assets.read can now be granted on an API key. Without them, non-public businesses, non-active products and business assets stay hidden (returned as 404) — behaviour for existing keys is unchanged.Docs →
AddedRelease notes: every endpoint, scope and error code now carries the version it was added in.Docs →
DocumentedRate limits: the per-key rolling 60-second window, 429 behaviour, and the fact that no Retry-After or X-RateLimit-* header is sent.Docs →
DocumentedAgent Gateway (agent.query) and the MCP server, including the required Accept: application/json, text/event-stream header.Docs →
DocumentedFull error and status-code table, including 503 from /v1/semantic-search when embeddings are unavailable.Docs →
FixedCorrected the documented list envelope to the flat { data, total, limit, offset } the API actually returns — there is no pagination object and no has_more field.Docs →
FixedCorrected the product pricing tiers key to product_pricing_tiers, and documented that search endpoints return grouped results rather than the list envelope.Docs →

1.0.0

Initial release

Initial /v1/ release. Everything below has been available since the API opened.

AddedBusinesses: list, get by id, get by slug, create, update, products, performance, capabilities, assets.Docs →
AddedProducts: list, get, create, update, price history.Docs →
AddedCategories, product categories, regions and countries.Docs →
AddedSearch: /v1/search, /v1/semantic-search, /v1/hybrid-search.Docs →
AddedRFQ and quotes: inbound RFQ creation, list, get, update, supplier attach/detach, quote read and submit.Docs →
AddedWebhook subscriptions: create, list, delete, with signed delivery.Docs →

Compatibility policy

Versions are semver inside the stable /v1/ path: a patch fixes something without changing behaviour you depend on, a minor adds endpoints, fields or scopes, and a change that would break an existing integration ships as /v2/ — never inside v1. A request whose first path segment is not v1 returns 400.

New endpoints, new optional query parameters, new scopes and new fields on existing responses can appear in any minor release.
Existing field names, types and response shapes stay as documented here for the life of v1.
Deprecations are announced before removal and removal happens only in a new major version.

Build a tolerant client: ignore unknown fields rather than failing on them, and never rely on key ordering or on the absence of a field. Then a minor release never breaks you.

Contracts you can rely on

List endpoints return the flat envelope { data, total, limit, offset } — derive further pages with offset + data.length < total.
Search endpoints (/v1/search, /v1/semantic-search, /v1/hybrid-search) return grouped results, not the list envelope.
Product pricing tiers are returned under the key product_pricing_tiers.
Money is always an amount plus a currency field; never a bare number.
Errors return a non-2xx status with { "error": "message" }.

Checking which release you are talking to

A GET on the base URL with no path is unauthenticated and returns the running version:

GET /json

{
  "service": "Buyamia Directory API",
  "version": "1.1.0",
  "status": "healthy",
  "docs": "https://buyamia.com/api-docs"
}

If that number is higher than the one shown in the header of these docs, open Release Notes — the entry for it is published at the same time as the deploy.

Staying informed

Breaking changes and deprecations are announced by email to the contact registered with your API key, ahead of the change. If you do not know who that is on your side, ask the Buyamia team to confirm the contact on file.

MCP Server

Current as of API 1.1.0 — released 7 September 2026