remix-api-reference

OpenAPI 优先规则

在生成或执行 API 调用之前，先获取：

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

以 OpenAPI 作为以下内容的权威契约来源：

• 方法（GET/POST/...）
• 路径
• 参数／查询／请求体架构
• 响应结构

基础请求头：

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

基础 URL：https://api.remix.gg

OpenAPI 界面：https://api.remix.gg/docs

响应封装

成功：

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

错误：

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

端点类别

具体路径以 OpenAPI 为准；以下是稳定的类别：

• 元数据：类别
• 游戏：列表／详情／创建／更新
• 分析：自有游戏的概览、商店和排行榜分析
• 版本：列表／详情／代码／线程／状态／验证／代码更新
• 资源：列出游戏资源，通过 POST /v1/games/{gameId}/assets 上传资源
• 图片：通过 POST /v1/games/{gameId}/images/generate 生成图片
• 商店图片：通过 POST /v1/games/{gameId}/images/generate-shop-icon 生成商店图标美术图
• 精灵图：通过 POST /v1/games/{gameId}/sprites/generate 生成精灵图
• 商品：通过 GET/POST /v1/games/{gameId}/items 和 POST/DELETE /v1/games/{gameId}/items/{itemId} 管理商店商品
• 就绪状态：启动就绪检查

Agent REST 未公开的功能

• 没有删除路由。
• 没有创建版本的路由。
• 没有提交路由。

资源上传

可通过 POST /v1/games/{gameId}/assets 上传资源。你可以直接通过 API 上传二进制文件（图标、精灵图、音频）。

也可以通过 Remix app/Studio 的上传流程管理资源。

标准流程：

1. 创建游戏
2. 上传／更新版本代码
3. 根据需要通过 POST /v1/games/{gameId}/assets 上传资源
4. 可选：通过概览／商店／排行榜端点查看分析
5. 验证和／或进行启动就绪检查
6. 检查状态

常见错误代码

• UNAUTHORIZED - 缺少或 API 密钥无效。
• ACCOUNT_INELIGIBLE - 用户已被封禁或删除。
• FORBIDDEN - 用户不拥有该游戏／版本。
• GAME_NOT_FOUND - 找不到游戏。
• VERSION_NOT_FOUND - 游戏／版本不匹配或不存在。
• MAX_IN_DEV_GAMES_EXCEEDED - 创作者已达到上限。
• VALIDATION_ERROR - 请求体／查询未通过验证。
• INVALID_JSON - 无法解析请求体中的 JSON。
• LIVE_VERSION_LOCKED - 尝试编辑已上线的版本。
• VERSION_NOT_EDITABLE - 版本已提交／批准／发布。
• THREAD_CREATE_FAILED - 无法创建上传线程。
• RATE_LIMITED - API 密钥已超出速率限制。
• INTERNAL_SERVER_ERROR - 服务器发生意外故障。