Getting Started
Set up your first broadcast in under 5 minutes — from camera to global audience.
Quick Start
Camera Setup
Connect SDI, NDI, or IP cameras. Best practices for green screen lighting.
Keying Parameters
Deep dive into sensitivity, edge softness, spill suppression, and shadow recovery.
AI Cloud
How our neural compositing engine works and how to configure it.
Integrations
OBS, vMix, Wirecast, and custom production switchers.
Best Practices
Tips from broadcast engineers running UltraKey at scale.
REST API
Programmatic access for automation and CI/CD.
Authentication
Send your API key in the Authorization header:
# All requests require a Bearer token
Authorization: Bearer uk_live_••••••••••••••3a7f
List broadcasts
GET /api/v1/broadcasts?status=live&limit=10
// Response
{
"data": [
{
"id": "bc_001",
"title": "Champions League — Matchday 7",
"status": "live",
"latency_ms": 7,
"resolution": "4K"
}
],
"total": 6
}
Start a broadcast
POST /api/v1/broadcasts
Content-Type: application/json
{
"title": "My broadcast",
"preset_id": "ps_001",
"resolution": "4K",
"input": "ndi://studio-cam-1"
}
Update keying parameters live
PATCH /api/v1/broadcasts/{id}/keying
{
"sensitivity": 72,
"edge_softness": 38,
"spill_suppression": 85,
"shadow_recovery": 60
}
Full API reference, SDKs (Node, Python, Go), and webhook documentation available at docs.ultrakeyproductions.com
System Status
All systems operational
Subscribe to status.ultrakeyproductions.com for incident notifications.
Need Help?
Production support is available 24/7 for Production and Enterprise plans.