# VersusGame (Versus)

> Interactive gaming and audience-engagement platform. An AI content-gamification engine turns
> publisher articles, live broadcasts and on-demand video into embeddable prediction games
> (MiniGames), with leaderboards, virtual wallets, coin/ticket economies, prize payouts and
> contextual "seamless ads" layered on top of partner content. One production REST API at
> api.versusgame.com exposes 239 operations across 190 paths.

VersusGame does not publish an llms.txt. This file is generated by API Evangelist from the live
OpenAPI document at https://api.versusgame.com/api-json and from the artifacts in this repository.
Generated 2026-08-02.

## API

- [Versusgame API reference (Swagger UI)](https://api.versusgame.com/api): interactive reference for the production API.
- [Versusgame OpenAPI 3.0.0](https://api.versusgame.com/api-json): the live machine-readable document. 190 paths, 239 operations, 286 component schemas. Note: `servers[]` is empty in the published document; the base URL is `https://api.versusgame.com`.
- Base URL: https://api.versusgame.com

## Authentication

- `Authorization: Bearer <jwt>` (securityScheme `access-token`, bearerFormat JWT) on user, creator and admin operations. Obtain via `POST /auth/login`, or social login against Apple, Google, Facebook or Microsoft (`GET /auth/{provider}` + `/auth/{provider}/callback`).
- `x-api-key` header (securityScheme `x-api-key`) on the two `/internal/*` service-to-service operations only.
- VersusGame is not an OAuth authorization server and declares no oauth2 scheme or scopes.

## Capability surface

- **Games** — create, update, declare and cancel two-sided prediction games (`GamesCreatorController_*`, `GamesAdminController_*`); public stats via `GamesUserController_getStats`.
- **Gameplays** — place a prediction, cancel it, claim the reward (`GameplaysController_*`).
- **Gamesets** — daily game sets, attempts, best/last attempt, cursor-paginated top players (`GameSetsController_*`, `GameSetPlaysController_*`).
- **Leaderboards** — active/previous boards, points, ledgers, eligible players, prize awards (`LeaderboardsController_*`, `LeaderboardsAdminController_*`).
- **Widgets** — the embeddable MiniGames surface, creator-managed and resolved for render (`WidgetsCreatorController_*`, `WidgetsControllerV2_*`).
- **Creators, playlists, custom URLs, categories, assets, keyframes** — content management for partner creators.
- **Wallets, ledger, cuts, products, payments** — coin/ticket balances, daily gift, fund history, revenue-share splits, Stripe purchases and GCOW prize payouts.
- **Autogame** — the AI pipeline: ingest an article, generate game drafts, version and promote them; plus OpenAI chat completions, Google search, ElevenLabs/Polly speech, Remotion render.
- **Meter ads, partner domains, notifications, profiles, personal information, achievements.**

## Conventions

- **Idempotency:** required `x-idempotency-key` header on 10 write operations (game creation, gameplay create/cancel/claim, Stripe payment create, GCOW payout, leaderboard create, game complaint, autogame game creation); a required `idempotencyKey` **query parameter** on 2 more. Retention and replay semantics are not documented.
- **Pagination:** `limit`/`offset` dominant; also `limit`/`skip`, `start`, and `cursor` on the two gameset top-player operations.
- **Field expansion:** `expand` and `_expand` (both spellings accepted) with per-resource enums.
- **Versioning:** URI path, three coexisting tiers — unversioned, `/v1`, `/v2`.
- **Errors:** `{"message": ..., "error": ..., "statusCode": ...}` (NestJS envelope). Not RFC 9457. Only 17 of 239 operations declare any 4xx; none declare 401, 403 or 5xx.
- **Rate limits:** not published.
- **Events:** none. Notifications are polled via `GET /v1/notifications`; there are no outbound webhooks and no AsyncAPI. `/v1/payments/callback/*` are inbound callbacks from Stripe and GCOW.

## API Evangelist artifacts

- [OpenAPI (verbatim)](openapi/versusgame-openapi-original.json)
- [Authentication profile](authentication/versusgame-authentication.yml)
- [API conventions](conventions/versusgame-conventions.yml)
- [Error catalog](errors/versusgame-problem-types.yml)
- [Lifecycle](lifecycle/versusgame-lifecycle.yml)
- [Data model](data-model/versusgame-data-model.yml)
- [Conformance](conformance/versusgame-conformance.yml)
- [Embedded components](components/versusgame-components.yml)
- [Agentic access contracts](agentic-access/versusgame-agentic-access.yml)
- [Agent skills](skills/_index.yml)
- [Candidate MCP tool set (not published by VersusGame)](mcp/versusgame-mcp.yml)
- [OpenAPI overlay](overlays/versusgame-api-overlay.yaml)
- [Domain security probe](security/versusgame-domain-security.yml)
- [Well-known probe (nothing found)](well-known/versusgame-well-known.yml)
- [Packages (none published)](packages/versusgame-packages.yml)

## Company

- [Website](https://www.versusgame.com/)
- [Terms of Service](https://www.versusgame.com/terms)
- [Business Service Terms](https://www.versusgame.com/business-service-terms)
- [Privacy Policy](https://www.versusgame.com/privacy)
- [Data Preferences](https://www.versusgame.com/data-preferences)
- [Rules](https://www.versusgame.com/rules)
- [Promotional Rules](https://www.versusgame.com/promotional-rules)
- [Contact](https://www.versusgame.com/forms/form-01)
- [LinkedIn](https://www.linkedin.com/company/versusgame)
- [Crunchbase](https://www.crunchbase.com/organization/versusgame)

## Not published

VersusGame publishes no developer portal, getting-started guide, SDK, CLI, Postman collection,
changelog, status page, deprecation policy, SLA, security.txt, trust center, pricing page, blog,
roadmap, MCP server or A2A agent card. The Swagger UI at https://api.versusgame.com/api is the
entire public developer surface.