mcpField
R
remix-api-reference

remix-api-reference

github.com/farworld-labsDevelopment57 installs
Repository

About remix-api-reference

remix-api-reference is a skill that directs API work against remix.gg to use its published OpenAPI specification as the source of truth. It is intended for agents working with game creation, versions, assets, analytics, and readiness checks through the API.

Key features

  1. 01Fetch the OpenAPI contract before API calls
  2. 02Reference game and version endpoints
  3. 03Manage game assets and shop items
  4. 04Generate images and sprites
  5. 05Inspect analytics and launch readiness

Use cases

  1. 01Check valid API paths and request schemas
  2. 02Upload game assets or update version code
  3. 03Review game analytics and launch readiness

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/farworld-labs/remix-skills --skill remix-api-reference

After installing, type/remix-api-referencein Claude Code to confirm it loaded.

Details

From the project README

OpenAPI-First Rule

Before generating or executing API calls, fetch:

  • https://api.remix.gg/docs/json

Use OpenAPI as the contract source of truth for:

  • methods (GET/POST/...)
  • paths
  • params/query/body schemas
  • response shapes

Base headers:

Authorization: Bearer <api_key>
Content-Type: application/json

Base URL: https://api.remix.gg

OpenAPI UI: https://api.remix.gg/docs

Response Envelope

Success:

{ "success": true, "data": { "...": "..." } }

Error:

{ "success": false, "error": { "code": "SOME_CODE", "message": "...", "details": null } }

Endpoint Families

Use OpenAPI for exact paths; these are the stable groups:

  • Metadata: categories
  • Games: list/detail/create/update
  • Analytics: overview, shop, and leaderboard analytics for owned games
  • Versions: list/detail/code/thread/status/validate/code-update
  • Assets: list game assets, upload assets via POST /v1/games/{gameId}/assets
  • Images: generate images via POST /v1/games/{gameId}/images/generate
  • Shop images: generate shop icon art via POST /v1/games/{gameId}/images/generate-shop-icon
  • Sprites: generate sprites via POST /v1/games/{gameId}/sprites/generate
  • Items: manage shop items via GET/POST /v1/games/{gameId}/items, POST/DELETE /v1/games/{gameId}/items/{itemId}
  • Readiness: launch readiness checks

Not Exposed in Agent REST

  • No delete route.
  • No create-version route.
  • No submit route.

Asset Upload

Asset uploads are available via POST /v1/games/{gameId}/assets. You can upload binary files (icons, sprites, audio) directly through the API.

Assets can also be managed through the Remix app/Studio upload flow.

Canonical flow:

  1. create game
  2. upload/update version code
  3. upload assets as needed via POST /v1/games/{gameId}/assets
  4. optionally inspect analytics via the overview/shop/leaderboard endpoints
  5. validate and/or launch-readiness
  6. check status

Common Error Codes

  • UNAUTHORIZED - Missing/invalid API key.
  • ACCOUNT_INELIGIBLE - User is banned/deleted.
  • FORBIDDEN - User does not own the game/version.
  • GAME_NOT_FOUND - Game missing.
  • VERSION_NOT_FOUND - Game/version mismatch or missing.
  • MAX_IN_DEV_GAMES_EXCEEDED - Creator reached cap.
  • VALIDATION_ERROR - Body/query failed validation.
  • INVALID_JSON - Body could not be parsed as JSON.
  • LIVE_VERSION_LOCKED - Attempted to edit a live version.
  • VERSION_NOT_EDITABLE - Version is submitted/approved/launched.
  • THREAD_CREATE_FAILED - Failed to provision upload thread.
  • RATE_LIMITED - API key rate limit exceeded.
  • INTERNAL_SERVER_ERROR - Unexpected server failure.

Comments

Markdown supported