Versioning policy
The current Machine API uses URL-path versioning. Send requests to the documented /v1/ endpoints and validate your integration against the published OpenAPI contract.
Major version — URL path
Section titled “Major version — URL path”The current major API version is identified in its path:
https://api.aggregator.gg/v1/...The commitment is compatibility: integrations built against the documented callback and API contracts are expected to keep working. A new major version, its migration path and any overlap period need an explicit release announcement; this page does not announce a /v2/ release.
Minor revisions
Section titled “Minor revisions”Additive changes can introduce optional fields, endpoints and error codes within /v1/. Clients should tolerate unknown response fields and test published changes before relying on them. The current API does not provide date-header negotiation or pinning to a historical response schema.
What counts as breaking
Section titled “What counts as breaking”Use these distinctions when assessing compatibility. They are integration guidance; a formal policy defining change classes and notice windows is still in work.
| Change | Major or minor? |
|---|---|
| Add a new endpoint | Minor (additive) |
| Add a new optional request field | Minor |
| Add a new field to a response | Minor (consumers must ignore unknown fields) |
| Add a new error code | Minor |
| Rename an existing field | Major |
| Remove an existing field | Major |
| Change the type of an existing field | Major |
| Tighten validation (previously accepted values rejected) | Major |
| Change the meaning of an existing field | Major |
Deprecation lifecycle
Section titled “Deprecation lifecycle”A written policy naming notice windows is in work. Until it is published, this guide does not promise a fixed notice period or a sunset date. Confirm the affected operation, migration requirements and applicable timing from its published release notice and your account contact.
This page does not establish that the deployed API emits deprecation headers or that the documentation renders a deprecation banner. Use the current OpenAPI contract and explicit release information to assess an operation’s status.
How we announce changes
Section titled “How we announce changes”Review the Changelog for published changes and confirm any migration schedule with your account contact. Email notification and dashboard-banner availability must be confirmed for the release; neither automatic delivery nor a notice deadline is established here.
Migration support
Section titled “Migration support”Before adopting a breaking change, obtain its migration instructions, target API contract and SDK compatibility guidance. Confirm the rollout schedule and support arrangements applicable to your integration.
TypeScript SDK 1.0.0 is available from npm as @aggregator-gg/sdk@1.0.0 and requires Node.js 24 or newer. Its availability does not establish support for a future API major version.