Create a lobby

Creates a new lobby and makes the caller the host. The caller is identified by the x-player-id header.

The lobby starts in waiting status. Other players can join via POST /{config}/join using the lobby ID or invite code (if the lobby is private).

Lobby config: The {config} path parameter maps to a lobby configuration defined in your project settings. Each config controls timeout, server size, matchmaking modes, and custom properties. If no matching config exists, sensible defaults are used.

Player state: Optionally pass state to set initial player state (ready status, team, loadout, MMR, etc.). Other players see this in the players array.

Private lobbies: Set isPrivate: true to hide the lobby from browsing and generate an invite code.

POST /api/v3/lobbies/{config}

Create a lobby

cURL

curl --request POST \
  --url https://api.computeflow.cloud/api/v3/lobbies/{config} \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --header 'x-player-id: <x-player-id>' \
  --data '
{
  "name": "<string>",
  "region": "us-east",
  "maxPlayers": 2,
  "isPrivate": false,
  "allowLateJoin": true,
  "settings": {},
  "state": {},
  "forceFresh": true
}
'

201

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "code": "<string>",
  "config": "<string>",
  "status": "waiting",
  "host": "<string>",
  "maxPlayers": 123,
  "currentPlayers": 123,
  "region": "<string>",
  "isPrivate": true,
  "allowLateJoin": true,
  "settings": {},
  "players": [
    {
      "id": "<string>",
      "state": {},
      "isHost": true
    }
  ],
  "server": {
    "instance_id": "<string>",
    "name": "<string>",
    "status": "launching",
    "network_ports": [
      {
        "name": "<string>",
        "internal_port": 123,
        "external_port": 123,
        "protocol": "udp",
        "host": "<string>",
        "tls_enabled": true
      }
    ],
    "startup_args": "<string>",
    "service_type": "match_based",
    "compute_size": "<string>",
    "region": "<string>",
    "version_tag": "<string>",
    "version": 123,
    "started_at": "2023-11-07T05:31:56Z",
    "stopped_at": "2023-11-07T05:31:56Z",
    "auto_restart": true,
    "custom_data": {},
    "ttl": 123,
    "is_pool_server": true,
    "pool_claimed_at": "2023-11-07T05:31:56Z",
    "match_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "matchmaking": {
    "mode": "<string>",
    "startedAt": "<string>",
    "queueStats": {
      "playersSearching": 123,
      "lobbiesInQueue": 123,
      "avgWaitSeconds": 123
    },
    "confirmation": {
      "deadline": "<string>",
      "confirmed": true
    }
  },
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "matchmakingError": "<string>"
}

Authorizations

api-key · string · header · required

Headers

x-player-id · string · required

Unique player identifier. This becomes the lobby host.

Path Parameters

config · string · required

Lobby configuration name or ID from project settings (e.g. "casual", "ranked_2v2").

Body

application/json

Create a new lobby. The caller (x-player-id) becomes the host.

name · string · required

Display name for the lobby. Shown to other players when browsing.

Required string length: 1 - 100

region · string · default: us-east

Preferred region for the game server. Available: us-east, us-south, us-west, eu-west, eu-north, ap-south, etc.

maxPlayers · integer · default: 2

Maximum number of players (1–100). Defaults to 2.

Required range: 1 <= x <= 100

isPrivate · boolean · default: false

If true, the lobby is hidden from browse and an invite code is generated.

allowLateJoin · boolean · default: true

If true, players can join after the game has started.

settings · object

Custom game settings (map, mode, difficulty, etc.). Passed to the game server as custom_data.

Show child attributes

state · object

Initial player state for the host (ready status, team, loadout, etc.).

Show child attributes

forceFresh · boolean

When true, delete any existing lobby this player owns in this config before creating the new one. Useful for "start a fresh session" flows where the host may be reconnecting from a prior session.

Response

201

application/json

Lobby created. The caller is the host. Share the id or code for others to join.

Full lobby state including players, server, and matchmaking info.

id · string<uuid> · required

Lobby ID.

code · string | null · required

Invite code for joining (null if private mode is disabled).

config · string · required

Lobby config name.

status · enum<string> · required

Current lobby status.

Available options: waiting, in_queue, starting, matched, match_found, in_game

host · string · required

Player ID of the host.

maxPlayers · number · required

Maximum player capacity.

currentPlayers · number · required

Current number of players.

region · string | null · required

Preferred game server region.

isPrivate · boolean · required

Whether the lobby is hidden from browsing.

allowLateJoin · boolean · required

Whether players can join mid-game.

settings · object · required

Custom game settings.

Show child attributes

players · object[] · required

Players in the lobby with their state.

Show child attributes

server · object | null · required

Game server info (null when no game running).

Show child attributes

matchmaking · object | null · required

Matchmaking info (null when not searching).

Show child attributes

createdAt · string · required

ISO 8601 creation timestamp.

updatedAt · string · required

ISO 8601 last update timestamp.

matchmakingError · string | null

Set when a queue entry was failed after repeated server-create failures. Explains why the match never formed; the lobby is returned to waiting so the player can retry.