Postman collection
The Machine API ships with a Postman collection generated automatically from the OpenAPI 3.1 spec. Import it once, then iterate on requests without typing curls by hand.
Download collectionPostman Collection v2.1.0 · JSON
What’s inside
Section titled “What’s inside”- Every operation in
openapi.yaml, grouped by tag (Games, Sessions, Transactions, Health) - Body schemas pre-filled with example values
- Three collection variables you can edit once and reuse everywhere
| Variable | Default | What to do |
|---|---|---|
base_url |
https://api.aggregator.gg/v1 |
Leave as-is for all operators |
apiKey |
sk_live_REPLACE_ME |
Paste your real key (see Authentication) |
idempotencyKey |
{{$randomUUID}} |
Leave as-is — Postman regenerates a UUID per request |
Import
Section titled “Import”Postman
Section titled “Postman”- Postman → File → Import → drag the downloaded JSON
- The collection appears under your workspace
- Open the collection’s Variables tab and paste your real
apiKey - Send any request
Insomnia
Section titled “Insomnia”- Insomnia → Application Menu → Import → choose From File → pick the JSON
- Update the environment variables in the Manage Environments dialog
Hurl / Bruno / other tools
Section titled “Hurl / Bruno / other tools”The collection is JSON in the standard Postman v2.1 format. Most modern API clients import it directly.
How it’s built
Section titled “How it’s built”Every CI build of docs.aggregator.gg regenerates the collection from openapi/aggregator.yaml via the openapi-to-postmanv2 converter. The download URL is stable — bookmark it.
The generation script lives at scripts/build-postman.mjs in the docs repo.
When the spec changes
Section titled “When the spec changes”Re-download the JSON. Postman does not auto-sync, so you should refresh the collection whenever we publish a Changelog entry that affects request or response shapes.