1 USD ≈ 27,000 credits · display only
Reference rate may change over time.
Integrator guide (Tier A)
Tier A means your product calls Gommo public API directly (v2.api.gommo.net + api.gommo.net). You do not need this repo’s gateway, portal, or /gateway/* paths.
Operators & dealers
Self-hosted Gommo Developer (portal, /billing/*, BYOK, observability) is optional and documented under Deploy and Portal & preview — not the default integration contract.
Start here
| Step | Doc |
|---|---|
| 1 | Principles — two hosts, Bearer, async jobs |
| 2 | Authentication — login, domain = registration domain |
| 3 | Quickstart — one image job end-to-end |
| 4 | Request lifecycle — create → poll → result (golden path) |
| 5 | Common errors · Webhooks — poll only on Tier A |
| 6 | Cookbook — copy-paste recipes (public URLs only) |
| 7 | TypeScript SDK — five-minute path (createAndWait) |
| 8 | Read the catalog · Models — never guess ratio / mode |
Registration domain (critical)
The form field domain is where the user signed up on Gommo (dealer tenant). It is not api.gommo.net or v2.api.gommo.net.
| In examples | Use |
|---|---|
| curl.exe | %REGISTRATION_DOMAIN% |
| PowerShell | $env:GOMMO_API_DOMAIN (throw if unset) |
| SDK / app code | Per-user value from your signup flow |
Wrong domain → wrong auth, credits, or billing dealer. See Authentication.
Mode A vs self-host (B/C)
| Mode | Who | Base URLs |
|---|---|---|
| A (Tier A) | Production integrators | https://v2.api.gommo.net, https://api.gommo.net |
| B/C | Operators running this repo | {your-api}/gateway/* — Integration modes |
Tier A docs (quickstart, models, cookbook, features) use Mode A URLs. Mode B/C appears only under Deploy → Self-host (advanced).
Gateway-only previews
Features that are not on public Gommo API yet (BYOK, observability webhooks, portal billing UX, usage aggregate via gateway, OpenAI shim, etc.) are marked Coming to Gommo platform and link to the roadmap. Do not build Tier A products against those unless you explicitly self-host.
English catalog (?lang=en)
Model descriptions for EN use cache/catalog-descriptions.en.json. Warm offline:
bash
npm run catalog:translate
npm run catalog:translate-th # optional TH cache
npm run catalog:cache-smoke # verify JSON in repoBrowser: /models/?lang=en · API (self-host): GET /gateway/models?type=image&lang=en. Full checklist: repo doc/CATALOG-TEST.md.
(Runtime docs default: read cache only; see repo .env.example.)
TypeScript SDK (Mode A default)
Package @ai-gateway/client (GommoClient) targets Gommo public hosts by default. Gateway transport: 'gateway' is for self-host operators only (billing preview, register proxy, etc.).
→ SDK overview · Test checklist: repo doc/SDK-TEST.md
Maintainers (this repo)
Before merging doc changes:
bash
npm run docs:smoke
npm run portal:smoke # when portal copy changed; needs docs:stack + API :3001Bulk-fix registration domain in examples: node scripts/normalize-domain-docs.mjs. Internal checklist: doc/TRACK-C.md.