• Studio

  • Bots

  • Web API

  • Designer Resources

  • Host Resources

  • Overview

    API

    Endpoints

    SessionMetadata

    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.

  • Name
    user_id
    Type
    string
    Is Required
    required
    Reference
    Description
  • Name
    room_info
    Type
    Is Required
    required
    Reference
    Description
  • Name
    rate_limits
    Type
    array
    Is Required
    required
    Reference
    Description
  • Name
    connection_id
    Type
    string
    Is Required
    required
    Reference
    Description
  • Name
    sdk_version
    Type
    string
    Is Required
    Reference
    Description
  • PocketWorlds Icon

    © 2024 Pocket Worlds. All rights reserved.