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 UI：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 アプリ／Studio のアップロードフローからも管理できます。

標準的なフロー：

1. ゲームを作成する
2. バージョンコードをアップロード／更新する
3. 必要に応じて POST /v1/games/{gameId}/assets からアセットをアップロードする
4. 必要に応じて概要／ショップ／リーダーボードのエンドポイントからアナリティクスを確認する
5. 検証および／または起動準備状況のチェックを行う
6. ステータスを確認する

よくあるエラーコード

• UNAUTHORIZED - API キーがないか、無効です。
• ACCOUNT_INELIGIBLE - ユーザーが BAN または削除されています。
• 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 - 予期しないサーバーエラーが発生しました。