Skip to main content

REST API Reference

Complete documentation for 500+ API endpoints

REST API v1
175 Endpoints Documented
JSON Responses

Stream Management

Create, manage, and control live streams with multi-protocol support

45 Endpoints
POST
/v1/streams
streams:write

Create new stream

Create a new live stream with specified protocol and configuration

GET
/v1/streams
streams:read

List all streams

Retrieve paginated list of streams with optional filters

GET
/v1/streams/{stream_id}
streams:read

Get stream details

Retrieve complete information about a specific stream

PATCH
/v1/streams/{stream_id}
streams:write

Update stream

Update stream configuration and metadata

DELETE
/v1/streams/{stream_id}
streams:write

Delete stream

Permanently delete a stream and associated resources

POST
/v1/streams/{stream_id}/start
streams:write

Start stream manually

Manually start a stream (if not auto-start)

POST
/v1/streams/{stream_id}/stop
streams:write

Stop stream

Stop an active stream and finalize recording

Analytics

Real-time and historical analytics for streams and viewers

28 Endpoints
GET
/v1/analytics/streams/{stream_id}
analytics:read

Get stream analytics

Retrieve comprehensive analytics for a stream

GET
/v1/analytics/viewers/{stream_id}
analytics:read

Get viewer metrics

Real-time viewer data including geography and devices

GET
/v1/analytics/engagement/{stream_id}
analytics:read

Get engagement metrics

Detailed engagement metrics including chat, reactions, shares

Content Management

Manage recordings, VOD content, and media library

35 Endpoints
GET
/v1/recordings
recordings:read

List recordings

Retrieve list of all recordings with pagination

GET
/v1/recordings/{recording_id}
recordings:read

Get recording details

Retrieve details and download URLs for recording

DELETE
/v1/recordings/{recording_id}
recordings:write

Delete recording

Permanently delete a recording file

POST
/v1/content/upload
content:write

Upload VOD content

Upload video file for on-demand streaming

Webhooks

Configure and manage webhook subscriptions

12 Endpoints
POST
/v1/webhooks
webhooks:write

Create webhook

Register new webhook endpoint for event notifications

GET
/v1/webhooks
webhooks:read

List webhooks

Retrieve all configured webhooks

DELETE
/v1/webhooks/{webhook_id}
webhooks:write

Delete webhook

Remove webhook subscription

POST
/v1/webhooks/{webhook_id}/test
webhooks:write

Test webhook

Send test event to webhook endpoint

User Management

Manage team members, roles, and permissions

22 Endpoints
POST
/v1/users/invite
users:write

Invite user

Send invitation to join organization

GET
/v1/users
users:read

List users

Get all users in organization

PATCH
/v1/users/{user_id}
users:write

Update user

Update user role and permissions

Billing & Subscriptions

Manage billing, subscriptions, and usage quotas

18 Endpoints
GET
/v1/billing/usage
billing:read

Get usage data

Retrieve current billing period usage

GET
/v1/billing/subscription
billing:read

Get subscription

Retrieve current subscription details

POST
/v1/billing/upgrade
billing:write

Upgrade subscription

Upgrade to higher tier plan

Admin

Administrative endpoints for system management

15 Endpoints
POST
/v1/auth/keys
admin

Generate API key

Create new API key with scopes

GET
/v1/admin/logs
admin:read

Get audit logs

Retrieve system audit logs

REST API Reference - WAVE API Documentation | WAVE