Skip to main content

Session

A rendering session.

clients object[]required

Current clients in session

  • Array [
    • client_iduuidrequired

    Client unique identifier

    client_type objectrequired
    oneOf
    user_iduuidrequired

    User unique identifier

    usernamestringrequired

    Used only for debug purposes

    Possible values: non-empty

    Example: John-Mitchell
  • ]
    • continent_codestringrequired

    Continent code of the rendering server location

    Example: NA
    country_codestringrequired

    Country code of the rendering server location

    Example: US
    created_atdate-timerequired

    Session creation date

    creator_user_iduuidrequired

    User identifier of the creator of the session

    folder_iduuidrequired

    The folder identifier of the scene

    is_transient_sessionbooleanrequired

    Whether the session is transient or not

    Example: NA
    max_usersint16required

    Maximum number of users allowed in this session at the same time

    Example: 10
    scene_iduuidrequired

    The main scene identifier of the session

    scene_namestringrequired

    The main scene name of the session

    Possible values: non-empty

    Example: My character
    session_iduuidrequired

    Session unique identifier

    Session
    {
      "clients": [
        {
          "client_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "username": "John-Mitchell"
        }
      ],
      "continent_code": "NA",
      "country_code": "US",
      "created_at": "2024-07-29T15:51:28.071Z",
      "creator_user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "folder_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "is_transient_session": "NA",
      "max_users": 10,
      "scene_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "scene_name": "My character",
      "session_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }