Skip to content
Documentation menu
Account and API / API Documentation

API Documentation

Create and control streams from your own tools. Included with Latchcast Studio.

NOT YET IMPLEMENTED

The API does not exist yet. Everything on this page is an illustrative shape for Stage 2 to confirm or replace.

Authentication

Send your API key as a bearer token. Create keys in Settings → API Keys.

Header
Authorization: Bearer $LATCHCAST_API_KEY

Create a stream

cURL · illustrative
curl -X POST https://api.latchcast.com/v1/streams \
  -H "Authorization: Bearer $LATCHCAST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Saturday IRL", "protection": true }'

Endpoints

MethodPathPurpose
GET/v1/streamsList streams
POST/v1/streamsCreate a stream
GET/v1/streams/{id}Stream status
POST/v1/streams/{id}/switch-sourceSwitch the on-air source
GET/v1/destinationsList destinations

Webhooks

EventSent when
stream.liveLatchcast starts receiving video
stream.backup_activeThe source is lost and backup content is shown
stream.restoredThe source reconnects
destination.failedA destination stops accepting the stream