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.
Authorization: Bearer $LATCHCAST_API_KEY
Create a stream
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
| Method | Path | Purpose |
|---|---|---|
| GET | /v1/streams | List streams |
| POST | /v1/streams | Create a stream |
| GET | /v1/streams/{id} | Stream status |
| POST | /v1/streams/{id}/switch-source | Switch the on-air source |
| GET | /v1/destinations | List destinations |
Webhooks
| Event | Sent when |
|---|---|
stream.live | Latchcast starts receiving video |
stream.backup_active | The source is lost and backup content is shown |
stream.restored | The source reconnects |
destination.failed | A destination stops accepting the stream |