# Social Stream API Sandbox

This Social Stream API Sandbox is a comprehensive tool for developers to test and interact with the Social Stream Ninja API. It provides a user-friendly interface to experiment with various API features, including message generation, user management, and channel-specific communications. For full API documentation, please visit socialstream.ninja/api.
🎮 Remote Control (StreamDeck/Bitfocus): Send commands like clear, nextInQueue, sendChat
→ Enable: Toggle 1 (Enable remote API control) — Connect to channel 1 (default)
📡 Chat Listener (Python/Node apps): Receive chat messages from Twitch/YouTube/etc.
→ Enable: Toggle 1 + Toggle 3 (Send chat messages to API server) — Connect to channel 4
Settings Location: Global settings > Mechanics
Alternatively, add &server or &server2 URL parameters to dock.html/featured.html pages.

## Connection Settings

Session ID:
Out Channel:
In Channel:

Note: The connection will automatically attempt to reconnect if disconnected. The session ID for the API needs to match the session ID provided by the extension; this should correspond to the ?session value found on the dock.html and featured.html links. Simply sending messages to the API using GET/POST messaging doesn't require a websocket connection.

## General Commands

These commands control the general behavior of the overlay and message queue.

## TTS Controls

TTS (Text-to-Speech) can be controlled separately for the dock and featured messages. You can also skip the currently playing TTS message to move to the next one in the queue. Make sure to enable the &server mode for the target you wish to directly interact with.

## Send Simple Message to Social Sites

Custom messages can be sent using different methods: WebSocket (WSS), HTTPS GET, or HTTPS POST. These are sent to sites like Twitch, Youtube, etc, and not directly to the dock.

## Advanced Message Generator - "fake an incoming message"

Username:
Message:
Platform:
Donation Amount:
Membership:
Avatar URL:
Name Color:
Event Type:
Content Image URL:
Mark as Question

Generate custom test messages to simulate different platforms and scenarios. This uses the `extContent` message type..

## Channel-Specific Messaging

Send messages to specific channels of the API server for more granular control of API messaging.

## Message Filters

Emote-only mode keeps only emotes/emoji from chat messages and drops messages that become empty after filtering.

## Waitlist Commands

These commands manage the waitlist functionality, useful for giveaways or queue management.

## Poll Commands

Extended poll controls allow you to load saved presets, create custom polls, and manage poll settings via the API.

## User Management

Manage users, including blocking, VIP status, and viewing history.

## Incoming Messages

This area displays incoming messages from the server.