LiveWing
CMS API

CMS API

Programmatic access to LiveWing's cloud CMS — collections, productions, live data, and AI agent.

The LiveWing CMS API provides HTTP endpoints for managing broadcast graphics, CMS collections, productions, and live data. It is hosted on the Convex deployment and authenticated via workspace API keys.

Base URL

https://ideal-heron-677.convex.site

Authentication

All endpoints require a workspace API key passed as a Bearer token:

Authorization: Bearer lw_<your-key>

API keys are created in the LiveWing web dashboard under workspace settings. Each key has a permission level:

  • read — can read graphics, collections, productions, and manifests
  • readwrite — can also modify data, publish graphics, update live data, and use the AI agent

Keys are hashed on the server and cannot be recovered after creation. Store your key securely.

Request Format

Most endpoints that take parameters use POST with a JSON body, even for operations that are semantically reads. This avoids embedding Convex document IDs in URL paths.

curl -X POST https://ideal-heron-677.convex.site/api/cms/productions/detail \
  -H "Authorization: Bearer lw_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"productionId": "j572abc..."}'

Response Format

All responses are JSON. Successful responses return the requested data directly. Errors return:

{
  "error": "Description of what went wrong"
}

HTTP Status Codes

CodeMeaning
200Success
201Created (returned for create operations)
400Bad request — missing or invalid parameters
401Unauthorized — missing, invalid, or expired API key
403Forbidden — key lacks required permissions
404Not found — resource does not exist or is not in your workspace
500Internal error

Sections

  • Collections — manage data tables (teams, players, venues)
  • Productions — create and manage broadcast events
  • Live Data — update scores, clocks, and other real-time data
  • AI Agent — send prompts to the CMS AI for automated setup
  • Graphics — query and control broadcast graphics

On this page