API Reference

curl -H "Authorization: Bearer YOUR_API_KEY" \
  http://localhost:8080/api/channels

curl -X POST http://localhost:8080/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{"username": "admin", "password": "yourpassword"}'

POST /api/auth/refresh

{
	"token": "eyJhbGciOiJIUzI1NiIs...",
	"expires_at": "2026-02-04T14:30:00Z"
}

GET /api/channels

{
	"channels": [
		{
			"id": "ch_abc123",
			"platform": "twitch",
			"name": "shroud",
			"enabled": true,
			"quality": "source",
			"status": "offline"
		}
	]
}

GET /api/channels/{id}

POST /api/channels

{
	"platform": "twitch",
	"name": "shroud",
	"quality": "source",
	"enabled": true
}

PATCH /api/channels/{id}

{
	"quality": "1080p60",
	"enabled": false
}

DELETE /api/channels/{id}

POST /api/channels/{id}/check

POST /api/channels/{id}/stop-recording

GET /api/channels/{id}/profile

POST /api/channels/{id}/images/fetch-platform

GET /api/channels/{id}/images/profile
POST /api/channels/{id}/images/profile
DELETE /api/channels/{id}/images/profile

GET /api/channels/{id}/images/banner
POST /api/channels/{id}/images/banner
DELETE /api/channels/{id}/images/banner

GET /api/recordings

{
	"recordings": [
		{
			"id": "rec_xyz789",
			"channel_id": "ch_abc123",
			"channel_name": "shroud",
			"platform": "twitch",
			"title": "Valorant Ranked",
			"status": "complete",
			"started_at": "2026-02-02T14:30:00Z",
			"duration": 10800,
			"file_size": 5368709120,
			"file_path": "/recordings/shroud/2026-02-02_Valorant Ranked.mp4"
		}
	],
	"total": 150,
	"limit": 50,
	"offset": 0
}

GET /api/recordings/{id}

DELETE /api/recordings/{id}

POST /api/recordings/{id}/reprocess

GET /api/recordings/active

{
	"active": [
		{
			"id": "rec_active123",
			"channel_name": "shroud",
			"platform": "twitch",
			"title": "Valorant Ranked",
			"started_at": "2026-02-02T14:30:00Z",
			"duration": 3600,
			"segments": 720,
			"quality": "1080p60"
		}
	]
}

POST /api/recordings/{id}/stop

POST /api/recordings/{id}/pause

POST /api/recordings/{id}/resume

GET /api/storage

{
	"total_used": 107374182400,
	"total_available": 536870912000,
	"quota": 214748364800,
	"quota_used_percent": 50,
	"by_channel": {
		"ch_abc123": 53687091200
	}
}

POST /api/storage/cleanup

GET /api/settings

PATCH /api/settings

{
	"output_directory": "/new/path",
	"max_concurrent_recordings": 5
}

GET /api/health

{
	"status": "healthy",
	"version": "1.0.0",
	"uptime": 86400
}

GET /api/logs

GET /api/system/dependencies

GET /api/auth/platforms
GET /api/auth/platforms/{platform}
PUT /api/auth/platforms/{platform}
DELETE /api/auth/platforms/{platform}
POST /api/auth/platforms/{platform}/test
POST /api/auth/platforms/{platform}/oauth/start
POST /api/auth/platforms/{platform}/oauth/callback
POST /api/auth/platforms/youtube/cookies
GET /api/auth/platforms/oauth/availability

POST /api/shutdown

const ws = new WebSocket("ws://localhost:8080/api/ws");

ws.onopen = () => {
	// Authenticate
	ws.send(
		JSON.stringify({
			type: "auth",
			token: "YOUR_API_KEY"
		})
	);
};

ws.onmessage = (event) => {
	const message = JSON.parse(event.data);
	console.log(message);
};

{
	"type": "recording.started",
	"timestamp": "2026-02-02T14:30:00Z",
	"data": {
		"id": "rec_xyz789",
		"channel": "shroud",
		"platform": "twitch",
		"title": "Valorant Ranked"
	}
}

{
	"type": "subscribe",
	"channels": ["ch_abc123", "ch_def456"]
}

{
	"type": "unsubscribe",
	"channels": ["ch_abc123"]
}

{
	"error": {
		"code": "CHANNEL_NOT_FOUND",
		"message": "Channel with ID ch_invalid does not exist"
	}
}