Skip to main content

πŸš€ 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.



Need help? Use the sidebar to jump to any section or head to the Authentication Guide to get started.