POST
/
api
/
cmd
/
RESET
curl --request POST \
  --url https://three.arcprize.org/api/cmd/RESET \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "game_id": "ls20-016295f7601e",
  "card_id": "8bb3b1b8-4b46-4a29-a13b-ad7850a0f916"
}'
{
  "game_id": "ls20-016295f7601e",
  "guid": "2fa5332c-2e55-4825-b5c5-df960d504470",
  "frame": [
    [
      [
        0,
        0,
        0,
        "…"
      ],
      [
        "…"
      ]
    ]
  ],
  "state": "NOT_FINISHED",
  "score": 0,
  "win_score": 254,
  "action_input": {
    "id": 0,
    "data": {}
  }
}

Authorizations

​
X-API-Key
string
header
required

Body

application/json

Game identifier, scorecard ID, and (optionally) the session guid.

Starts a new game session or resets an existing one, depending on whether a guid is supplied.

• No guid (null/empty) → A brand-new game instance is created and the response will include its freshly minted guid.

• With guid → The server issues a reset to that specific instance: - If at least one ACTION command has been executed in the current level, only that level is reset (typical “try again” behaviour). - If no ACTION commands have been executed since the last level transition, the entire game is reset to its initial state.

Sending two RESET commands back-to-back therefore always yields a completely fresh game.

All plays should be associated with an open scorecard via card_id so aggregated results can be tracked.

Response

200
application/json

First frame after starting or resetting the session.

Snapshot returned after every RESET or ACTION command.
Includes the latest visual frame(s), cumulative score details, the current game state, and an echo of the triggering action.