Skip to content

OpenAPI ​

Download or browse the OpenAPI 3.0 spec for the Gommo public API (v2.api.gommo.net + api.gommo.net). The same file also lists optional Gommo Developer dev endpoints for operators (billing, admin, Mode B REST).

Async media jobs (Tier A) ​

The Gommo V2 tag covers the golden path:

OperationPathAfter success
List catalogPOST /ai/modelsRead ratio / mode / … from response — Read the catalog
CreatePOST /ai/jobs/{type}/{modelSlug}Save job id_base from body
PollPOST /ai/jobs/{id} (+ media query)Repeat 3.5s, max 80 until result_url

Gommo does not webhook job completion on the public API — Request lifecycle · Webhooks.

Generate clients from openapi.yaml (see below) or use TypeScript SDK.

Spec file ​

DevProduction
http://localhost:5173/openapi.yamlhttps://docs.yourdomain.com/openapi.yaml

Default servers (Swagger) ​

ServerDescription
https://v2.api.gommo.netJobs, models, upload, album library
https://api.gommo.netAuth, chat, audio, info, library lists

Each operation sets servers when it only applies to one host. See Gommo public API for the full map.

Gommo public path groups ​

TagHostExamples
Gommo V2v2.api.gommo.net/ai/models, /ai/jobs/{type}/{model}, /ai/library/album-images
Gommo Platformapi.gommo.net/ai/me, /api/v2/chat, /ai/info/image/{id}, /api/apps/go-mmo/ai/public-videos

Self-host only (operators) ​

These tags apply when you run this repo locally (localhost:3001) — not the default integrator contract:

TagServerExamples
Gateway Devlocalhost:3001/gateway/jobs/{type}, /gateway/models
Billinglocalhost:3001/billing/payment/*
Adminlocalhost:3001/admin/*

→ Deploy → Self-host (advanced)

Auth in spec ​

Security schemeUsed on
bearerAuthGommo public paths, /gateway/*, billing
adminKey (x-admin-key)/admin/*

Human-readable reference ​

→ Quickstart · Gommo public API · Media & jobs · Read the catalog · Authentication

Next ​

→ Endpoint map · Integration modes