Video Render API

Generate branded video programmatically on the Series-X VPS. Remotion-backed, queue-backed, async.

Base URL: https://video-api.series-x.ai (planned) or http://127.0.0.1:8800 (VPS-local) Auth: X-API-Key header. Key distribution: ask Colin/Alex. Service: video-api.service on server1.series-x.ai

Quick start

# Submit a render (returns immediately)
curl -X POST https://video-api.series-x.ai/render \
  -H "X-API-Key: $VIDEO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"composition":"SeriesXIntro","props":{"title":"Welcome to AdvisorPro","subtitle":"AI systems, documented and verified"},"codec":"h264"}'
# => {"jobId":"job_x7k2m9a1p3","state":"queued"}

# Poll progress
curl -H "X-API-Key: $VIDEO_API_KEY" https://video-api.series-x.ai/status/job_x7k2m9a1p3
# => {"id":"job_x7k2m9a1p3","state":"rendering","progress":57}

# Download when state=done (200) - mp4, H.264 yuv420p
curl -o out.mp4 -H "X-API-Key: $VIDEO_API_KEY" https://video-api.series-x.ai/download/job_x7k2m9a1p3

Endpoints

POST /render

Returns {jobId, state}. Renders run 3-at-a-time; extra jobs queue FIFO.

GET /status/:jobId

Returns {id, state, progress, composition, error}. state is one of queued, rendering, done, error. On error, error carries a short message.

GET /download/:jobId

Streams the mp4. Only valid once state=done. 404 otherwise.

GET /health

No auth. {ok, activeJobs, queued, maxConcurrent}.

Available compositions

New compositions: add to /opt/motion-graphics/src/Root.tsx in the git repo (series-a-uk/series-x-crm), then systemctl restart video-api.

Throughput and limits

• 1080p 30fps. A 4s intro renders in ~25s. A 66s explainer in ~5-7 min.
• 3 concurrent renders; sustained capacity ≈ 1 long-form video / 2 min, or ~5 shorts/min.
• Request body limit 2 MB. Props are JSON only — pass media as URLs, not base64.
• First job after a service restart pays a ~40s one-off warmup (bundle + headless Chrome).

Voiceover and music

VO (edge-tts) and music beds are generated per-project, not yet part of the API surface. For API-scale VO, cache by script hash or supply an ElevenLabs key. Music is synthesised in-house (licence-free).

Errors