Skip to content

Create a demo session

POST
/demo-sessions

Launch a demo game session. No real-money wallet involvement; no bet or win callbacks emitted. Useful for demo previews or prospect-facing free-play surfaces. Demo sessions are non-financial and do not require an Idempotency-Key header.

object
game_id
required

The Aggregator catalog game UUID — the id from GET /v1/games. NOT the provider’s provider_game_id.

string format: uuid

Demo session created.

object
session_id
required
string format: uuid
game_url
required

One-time-use signed URL the player is redirected to.

string format: uri
provider_session_uid
string
provider_code
required
string
warning

Reserved for legacy use. Currently never set.

string

Missing, invalid, or revoked API key.

object
error
required
object
code
required

Machine-parseable error code. See https://docs.aggregator.gg/resources/error-codes/.

string
/^E[0-9A-F][0-9]{3}$/
E0001
type

Snake-case mnemonic for the code (e.g. game_blocked_jurisdiction, player_self_excluded). Branch on code; type is for readability.

string
game_blocked_jurisdiction
message
required
string
request_id

Correlation ID for support escalation.

string
details
object
key
additional properties
any

Game not found or does not support demo mode.

object
error
required
object
code
required

Machine-parseable error code. See https://docs.aggregator.gg/resources/error-codes/.

string
/^E[0-9A-F][0-9]{3}$/
E0001
type

Snake-case mnemonic for the code (e.g. game_blocked_jurisdiction, player_self_excluded). Branch on code; type is for readability.

string
game_blocked_jurisdiction
message
required
string
request_id

Correlation ID for support escalation.

string
details
object
key
additional properties
any