Getting Started
The Teradek REST API lets you programmatically control your broadcast encoders. Integrate with your production automation, build custom control interfaces, or manage device fleets.
Requires Apollo OS 2.25 or later.
Base URL
All API requests target your device directly over the network:
Base URL
https://<device-ip>/api/v1Quick Start
Follow these steps to make your first API request.
1. Obtain an Access Token
Authenticate using the OAuth 2.0 password grant:
cURL
curl -X POST https://<device-ip>/oauth/token \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "grant_type=password&password=<your-password>"2. Make an API Request
Use the access token to query device information:
cURL
curl https://<device-ip>/api/v1/system/info \
-H "Authorization: Bearer <access_token>"3. Handle the Response
All responses are returned as JSON:
JSON Response
{
"model": "Prism-855",
"serial": "12855XXXXX",
"firmware": "2.25.20260122"
}Endpoint Discovery
Accessing any path that contains sub-endpoints returns an endpoints array in the response, allowing programmatic navigation of the API surface.