StreamAPI Documentation

Complete reference documentation for the StreamAPI livestreaming platform.

v1.0.0

REST API

WebSockets

RTMP

Getting Started

StreamAPI provides a comprehensive set of APIs for creating, managing, and interacting with livestreams. Follow these steps to get started with our platform.

Create an account - Sign up for StreamAPI and create your first project.
Get your API key - Generate an API key from the dashboard.
Make your first API call - Use the examples below to make your first API call.
Set up a stream - Create your first livestream using our API.

Create Account Get API Key

terminal

Core Concepts

Streams

Streams are the core resource of the API. A stream represents a single livestreaming session with its own unique RTMP ingest point and playback URLs.

Viewers

Viewers are users who watch your streams. The API provides real-time viewer counts, engagement metrics, and viewer management capabilities.

Events

Events are notifications about changes to your streams, such as when a stream starts, ends, or experiences technical issues.