
    The endpoint for persistent room bots.
    

Move the bot to the given furniture Anchor Position.

The successful response to a `AnchorHitRequest`.

Change the room privileges for provided `user_id`.
This can be used to both give and take moderation and designer privileges for current room.

Bots have to be in the room to change privileges.
Bots are using their owner's privileges.

The successful response to a `ChangeRoomPrivilegeRequest`.

Send a hidden channel message to the room.

This message not be displayed in the chat, so it can be used to
communicate between bots or client-side scripts.

A channel message has been successfully sent.

A chat event, sent by a `user` in the room.

Send a chat message to a room.

The chat message will be broadcast to everyone in the room, or whispered to `whisper_target_id` if provided.

Returns the status of voice chat in the room.
seconds_left: The number of seconds left until the voice chat ends.
auto_speakers: The list of users that automatically have voice chat privileges in the room like moderators and
owner.
users: The list of users that currently have voice chat privileges in the room.

A Highrise currency amount.

The most used currencies are:
* `gold`
* `bubbles`

Many other currencies exist, however.

An emote event, performed by a `user` in the room.

Perform an emote.

Some of the available emotes are:
* "emoji-angry",
* "emoji-thumbsup",
* "emote-hello",
* "emote-tired",
* "dance-macarena"

`target_user_id` can be provided if the emote can be directed toward a player.

The successful response to a `EmoteRequest`.

The client request or parameter was invalid.

The successful response to a `FloorHitRequest`.

Get the conversations of a bat. if not_joined is true, only get the conversations that bot has not joined yet will
be returned. 20 conversations will be returned at most, if all 20 conversations are returned, the last_id can be used
to retrieve the next 20 conversations.

The conversations of a bot. This will return list of max 20 conversations.
not_joined: The number of conversations that bot has not joined yet. Those are not returned in the conversations
list unless not_joined is true.

Get the messages of a conversation. 20 messages will be returned at most, if all 20 messages are returned, the
last_message_id can be used to retrieve the next 20 messages. conversation_id must be provided.

The messages of a conversation. This will return list of max 20 messages.

Fetch the room privileges for provided `user_id`.

The room privileges for provided `user_id`.

Fetch the list of users currently in the room, with their positions.

The list of users in the room, alongside their positions.

The outfit of a user. Returns list of items user is currently wearing.

Fetch the bot's wallet.

The wallet contains Highrise currencies.

Send a keepalive request.

This must be sent every 15 seconds or the server will terminate the connection.

The successful response to a `KeepaliveRequest`.

A message event, indicating that bot has received a message from someone. If the message is from a new conversation,
`is_new_conversation` field will be True.

Moderate the room.

This can be used to kick, ban, unban, or mute a user.

The successful response to a `ModerateRoomRequest`.

Move the provided `user_id` to the provided `room_id`.

The successful response to a `MoveUserToRoomRequest`.

A reaction event, performed by a `user` in the room.

Send a message to a conversation. If bot wishes to send room invite, the room_id must be provided.

Initial session data.

This will be sent once, as the first message when a connection is established.

user_id: The user ID of the bot.

room_info: Additional information about the connected room.

rate_limits: A dictionary of rate limits for the current session. The keys are the names of
the rate limits, and the values are a tuple of (limit, period). Bot API is using leaky bucket algorithm
to limit the number of requests. The limit is the number of requests that can be made initially,
and period is the time in seconds for the limit to be refilled. So for example, if the limit is 10 and period is 1,
client can make 10 requests in 1 second, and then 1 request every second after that. A good rule of thumb is to not
send more than 1 request per second. Note that if you exceed the rate limit, the server will
just process your requests slower.

connection_id: A unique ID for the current connection. This is used to identify the connection and help with
debugging. Please include this ID in any bug reports.

sdk_versions: recommended SDK version. This is a string that contains the recommended SDK version if client is
using any of official SDKs like `https://pypi.org/project/highrise-bot-sdk/`. And only if client is not using
recommended version already.

Teleport the provided `user_id` to the provided `destination`.

The successful response to a `TeleportRequest`.

The `sender` has sent `receiver` a tip (the `item`) in the current room.

A Highrise user.

Keep in mind it's possible for users to change their username,
but their ID will never change.

Event that is sent when status of voice is changed in the room.

users: The list of users that currently have voice chat privileges in the room and status of their voice.
seconds_left: The number of seconds left until the voice chat ends.

# Introduction
The Highrise API is a tool for developers to access and manipulate the
Highrise virtual world. It allows for the creation of virtual objects,
avatars (bots), and interactions within the world. The API is well-documented and
supported, making it easy for developers to get started with creating
their own Highrise-powered experiences and bots.
 
There are multiple ways to interact with the Highrise API. The first of
which is a direct connection to the API via a web socket. This method
allows you direct access to the JSON payloads coming in and out and you
can use whatever programming language you prefer. Alternatively a few
different SDKs are provided that take care of all the plumbing and setup
necessary, and enable access to the API via structured data and functions.
Both methods are equivalent and you’re welcome to choose either.
 
### Python SDK
The Python SDK can be found here:
[https://pypi.org/project/highrise-bot-sdk](https://pypi.org/project/highrise-bot-sdk)

### .NET SDK
The .NET SDK can be found here:
[https://github.com/pocketzworld/highrise-net-sdk](https://github.com/pocketzworld/highrise-net-sdk)

### API
The documentation for endpoints and URLs for direct API access is found at the bottom of this page.
 

# Bots
A Highrise bot is a software program or application that integrates with
the Highrise platform. These bots are designed to perform specific tasks,
automate processes, and interact with users in a Highrise room.
 
Highrise bots can provide a wide range of functionalities, such as moderating
conversations, playing music, managing roles and permissions, providing game
statistics, conducting polls, and many other tasks that help enhance the user
experience within a room. They can be developed using different programming
languages such as JavaScript, Python, or Java, and are usually hosted on a
separate server to ensure continuous operation. Highrise bots can be added to
a Highrise room by the room's owner and moderators, and they utilize the Highrise
API to interact with the platform and its users.
 
A Highrise bot, like any software application, has an owner or developer who
is responsible for its creation, maintenance, and behavior. This owner plays
a crucial role in ensuring that the bot adheres to the rules and guidelines
of the platform it operates on. It is important to note that the bot owner is
accountable for any misconduct or inappropriate actions performed by their bot.
As a result, it is essential for bot owners to closely monitor their bot's
actions,implement measures to prevent misuse, and promptly address any issues
that may arise. In doing so, they contribute to a healthy and secure community
experience for all users on the platform.

## Creating a Bot
> To ensure the best experience for all our users, bot creation is only
accessible to trusted users.

Go to [https://highrise.game](https://highrise.game), log in with the
user you intend to be owner of your bot, and navigate to the *Settings* page.
At the bottom of this page you'll find a section for *Bots* and from here
you're able to create a new bot and retrieve its API access token.

## Retrieving the Room ID
Bots can only be deployed to rooms that the bot owner has privilege in (user who
the bot is created under). These are rooms that the bot owner either owns
or has design privilege in. To retrieve the ID of the room you want to deploy
the bot to, you can visit the room in the Highrise App, navigate to the room info
panel on the top right and select "Share this Room". This will generate a link
that contains the ID of the room. You'll be able to use this ID in your API/SDK
calls to send the bot to that room.

## Subscribing to Events
By default bots will receive all events that occur in the room they are deployed to.
This can be a lot of data, and you may only be interested in a subset of events.
To subscribe to specific events you can send optional query parameter events while
connecting to websocket. The value of this parameter should be a comma separated
with list of all events you want to subscribe to. For example, if you only want
to receive chat messages and avatar joined events, you can send the following
query parameter: `?events=chat,user_joined`. The full list of events can be
found in the API documentation below.

### List of possible events
Note that chat covers both chat and whisper events.
 - chat
 - emote
 - reaction
 - user_joined
 - user_left
 - user_moved
 - tip_reaction
 - voice
 - channel


 

# API Documentation

Schema

Company

Resources

Legal

Social