Communications

Get scene communication adapter

post
/get-scene-adapter

Generates LiveKit credentials for a user to join a scene's communication room. This endpoint handles authentication, blacklist checking, scene ban verification, and generates appropriate permissions for the user. Requires Signed Fetch authentication from decentraland-kernel-scene. Must include the complete identity header chain: x-identity-auth-chain-0, x-identity-auth-chain-1, x-identity-auth-chain-2, x-identity-timestamp, and x-identity-metadata.

Authorizations
x-identitystringRequired

Signed Fetch authentication for scene-based requests. Requires a chain of identity headers:

  • x-identity-auth-chain-0: Signer information
  • x-identity-auth-chain-1: Ephemeral key information
  • x-identity-auth-chain-2: Signed entity information
  • x-identity-timestamp: Request timestamp
  • x-identity-metadata: Request metadata Used for authentication from decentraland-kernel-scene.
Body
objectOptional

Signed fetch request with scene and user information

Responses
chevron-right
200

Scene adapter generated successfully

application/json
adapterstringRequired

LiveKit connection URL for the scene

post
/get-scene-adapter

Get scene participants

get
/scene-participants

Retrieves the list of participant wallet addresses connected to a scene or world room.

Query Parameters:

  • pointer + realm_name: For scene rooms (pointer is the base parcel, e.g., "-7,-2"). The scene ID is resolved from the catalyst. realm_name defaults to "main".

  • realm_name alone: Treated as a world name (e.g., "mycoolworld.dcl.eth")

Response: Returns an array of wallet addresses (lowercase, 42 characters) of users currently connected to the room. Returns an empty array if the room doesn't exist or has no participants.

Query parameters
pointerstringOptional

Scene base parcel (e.g., "-7,-2"). The scene ID is resolved from the catalyst using this pointer. When provided, realm_name defaults to "main" if not specified.

Pattern: ^-?\d{1,3},-?\d{1,3}$
realm_namestringOptional

When used with pointer: identifies the realm for scene rooms (default: "main"). When used alone (without pointer): treated as a world name (must end with .dcl.eth).

Responses
chevron-right
200

Room participants retrieved successfully

application/json
okbooleanOptionalExample: true
get
/scene-participants

Last updated