Introduction

README

Welcome to the BeeStreamed API documentation. This API allows you to interact with the BeeStreamed platform programmatically, enabling you to manage streaming events, analyze viewer data, and engage with your audience.

Authentication

All API requests require authentication using an access token. Include your token in the request header:

Authorization: Basic base64_encode({token_id}:{secret_key})

Core Resources

The API is organized around these main resources:

  • Events - Create, manage, and control streaming events
  • Analytics - Access viewer statistics and engagement metrics
  • Chat - Manage chat messages and Q&A for events
  • Client - Access channel information
  • Polls - Create and manage polls for audience engagement
  • Signup - Manage event registrations and attendees

Rate Limiting

The API implements rate limiting to ensure fair usage:

  • 200 requests per minute for standard endpoints
  • 3500 requests per minute for authenticated endpoints

If you exceed these limits, you'll receive a 429 Too Many Requests response.

Response Format

All API responses are returned in JSON format and include a status field indicating the HTTP status code.

Error Handling

The API uses standard HTTP status codes to indicate success or failure:

  • 200: Success
  • 201: Resource created
  • 400: Bad request
  • 401: Unauthorized
  • 403: Forbidden
  • 404: Resource not found
  • 405: Method not allowed
  • 422: Validation error
  • 429: Rate limit exceeded
  • 500: Server error

Error responses include a message explaining what went wrong.