API reference
Authenticate, run jobs, upload recordings and download media with the FoxCue API. 6 articles
Getting Started
REST APIUse the FoxCue REST API to work with brands, sources, scripts, outputs and recordings from code. Scoped bearer keys, OpenAPI schema and async jobs.API authenticationAuthenticate to the FoxCue API with a scoped workspace API key in the Authorization header. Key expiry, revocation and the full list of permission scopes.
Concepts
API jobsQueue FoxCue script, article, slide and video jobs with POST /jobs and an Idempotency-Key, poll GET /jobs/{id} for status, and cancel. No webhooks yet.Upload recordings and download media via APIUpload raw recording tracks to FoxCue with POST /recordings and a retry-safe upload_id, then download rendered media with GET /media using its storage key.API rate limits, size limits and error codesFoxCue API limits: 120 requests per minute per workspace, 512 KiB JSON bodies, 64 MiB uploads, 3 active jobs, plus how errors and 409 conflicts work.