Skip to main content
← Back to Documentation

Complete API Reference

RESTful API for live streaming infrastructure

REST API
v1
Stable

Base URL & Authentication

Connect to WAVE's production API

Base URL

https://api.wave.inc/v1

Authentication

Authorization: Bearer wave_live_xxxxx

Generate API keys at /dashboard/api-keys

Authentication

3 endpoints

POST
/v1/auth/keys

Generate API keys

Required scopes:admin
GET
/v1/auth/keys

List API keys

Required scopes:admin:read
DELETE
/v1/auth/keys/{key_id}

Revoke API key

Required scopes:admin

Streams

5 endpoints

POST
/v1/streams

Create new stream

Required scopes:streams:write
GET
/v1/streams

List streams

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

Get stream details

Required scopes:streams:read
PATCH
/v1/streams/{stream_id}

Update stream

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

Delete stream

Required scopes:streams:write

Recordings

3 endpoints

GET
/v1/recordings

List recordings

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

Get recording details

Required scopes:recordings:read
DELETE
/v1/recordings/{recording_id}

Delete recording

Required scopes:recordings:write

Analytics

2 endpoints

GET
/v1/analytics/streams/{stream_id}

Get stream analytics

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

Get viewer metrics

Required scopes:analytics:read

Webhooks

3 endpoints

POST
/v1/webhooks

Create webhook

Required scopes:webhooks:write
GET
/v1/webhooks

List webhooks

Required scopes:webhooks:read
DELETE
/v1/webhooks/{webhook_id}

Delete webhook

Required scopes:webhooks:write

Example: Create Stream

Complete request and response example

POST /v1/streams
Host: api.wave.inc
Authorization: Bearer wave_live_xxxxx
Content-Type: application/json

{
  "title": "Product Launch Event",
  "protocol": "webrtc",
  "recording": {
    "enabled": true,
    "format": "mp4",
    "storage": "cloud"
  },
  "transcoding": {
    "enabled": true,
    "profiles": ["720p", "1080p"]
  },
  "metadata": {
    "category": "business",
    "tags": ["product", "launch", "2025"]
  }
}
API Reference - Complete Documentation | WAVE Docs | WAVE