Skip to main content

Introduction

The BEAM® Chat API allows you to create chat bots or multi-platform chat aggregators. When a streamer is multistreaming through BEAM, you gain access to their chats from other supported services. With a User Access Token, your application will receive private events, such as viewers joining or following the channel, and be able to send chat messages on BEAM.

Note that this is a convenience API that internally interacts with Data API, and many use cases can be implemented using the Data API directly.

Private Beta

Chat API is in private beta. Request access on this page.

Concepts​

BEAM is building a new generation of real-time interactions with streamers, viewers, and developers in mind. Chat bots on BEAM can be invoked with message commands or they can also create custom controls like buttons or radio lists. Bots can act as passive readers of chat messages or they can intercept messages and respond to them privately. Chat bots can add context to chat messages, like custom badges or tags. This flexibility allows for a more dynamic and interactive chat experience, enhancing the engagement between streamers and their audience.

Getting Started​

  1. The Chat API is in private beta. Request access on this page.
  2. Once authenticated, create an app on the My Apps page.
  3. Before creating an API token, read about Authentication.
  4. Decide how you will access the API by reading about Limits.
  5. Understand how versioning works and how breaking changes are introduced on the Versioning page.
  6. You are now ready to build your app or chat bot using the BEAM Chat API.

Getting Help​

If you encounter an issue, have questions or suggestions, or would like to report a non-security-related bug, join our Discord server. For unique integration discussions, custom endpoint requests, or to report a security vulnerability, email us at developer@beamstream.gg.