Tscaps documentation
Integrate captioned video generation and automated subtitle burn-in into your product with the tscaps API.
Welcome to the tscaps developer documentation. Use the Automation API to generate videos with burned-in subtitles and synchronized word-level animations directly from your product, backend services, or automated workflows.
All captioning, transcription, and frame-by-frame rendering runs on our cloud infrastructure, driven by the same typography and motion engine as the tscaps Studio editor.
Documentation
Introduction & Quickstart
Get up and running with your first video in under five minutes. Learn how to authenticate, queue an automation job, monitor its rendering progress, and download the finished MP4 video.
API reference
Exhaustive technical reference for all endpoints (POST /v1/automation-jobs, GET /v1/automation-jobs/:id, POST /v1/automation-jobs/:id/cancel, POST /v1/automation-jobs/uploads, GET /v1/automation-jobs), parameter schemas, frame budgets, and failure codes.
Direct file uploads
Upload video files directly to tscaps cloud storage via presigned URLs when your files are stored locally, behind authentication, or uploaded by your users.
Webhooks
Receive real-time HTTP event deliveries as soon as video rendering finishes. Includes complete Standard Webhooks HMAC-SHA256 signature verification examples in JavaScript and Python.
Limits & quotas
Compare video duration, frame resolution budgets (720p vs 1080p), concurrent job execution slots, and automation minute billing across the Free, Starter and Pro plans.
Developer resources
Manage your account credentials, monitor active jobs, and browse available caption templates in the developer dashboard:
- API keys: Generate, view, and revoke secret API keys.
- Automation minutes: Monitor your remaining minute balance and purchase non-expiring minute packs.
- Usage & history: View active and past automation job runs with real-time statuses and execution logs.
- Templates catalog: Browse all built-in caption styles and custom templates saved to your account.
- Webhooks signing secret: View and rotate your account’s webhook signing secret.
Building with AI agents
Equip your AI coding assistant (Cursor, Claude Code, GitHub Copilot, Windsurf, etc.) with the complete API specification or install our official skill:
- Full API reference for LLMs: Single-file raw markdown dump of all API guides and endpoint schemas for one-shot agent ingestion.
- Documentation index: Machine-readable documentation index following the llmstxt.org standard.
- Official Agent Skill (
tscaps-api): Install vianpx skills add francozanardi/tscaps --skill tscaps-apior view SKILL.md on GitHub.