π Quick Start Guide
Welcome to Scriptix! This guide will help you start transcribing audio or video in just a few steps β whether you're building an app, automating transcription at scale, or exploring speech-to-text for the first time.
π§ Choose a Transcription Modeβ
Scriptix supports two main ways to transcribe:
- π¦ Batch Processing β Upload files for asynchronous transcription using the TUS protocol.
- β‘ Realtime Processing β Stream audio live via WebSocket and receive instant results.
π Use the latest V2 APIs for all new integrations. V1 versions are still available under βLegacy APIβ if needed.
π§Ύ Setup in 4 Stepsβ
1. Authenticateβ
Get your API token and include it in every request using the API key format.
2. Send Your Audioβ
Upload a file using the Batch API or start streaming with the Realtime API.
3. Manage Your Jobsβ
Track transcription status, fetch results, or perform updates using the Documents API.
4. Enhance the Outputβ
Translate transcripts or generate shareable Magic Links.
π Already Using V1?β
Check the Migration Guide to upgrade to V2 with minimal friction. The new APIs offer better structure, performance, and control.
π Related Topicsβ
- Update or delete transcripts
- Train a domain-specific model
- Manage customers via Reseller API
- View error codes and responses
Need help? Use the sidebar to jump to any section or head to the Authentication Guide to get started.