Skip to main content

Batch Processing Overview

The Scriptix Batch API lets you transcribe pre-recorded audio or video files asynchronously. It’s designed for high reliability, large files, and automation workflows.

💡 Recommended for file uploads larger than 5MB or jobs that don’t require real-time results.

🚀 Key Features​

  • Asynchronous job handling (non-blocking)
  • TUS protocol support for resumable uploads
  • Scalable for large files and automation pipelines
  • Optional features: speaker diarization, punctuation, alignment

🧭 How It Works​

The modern batch workflow follows three main steps:

  1. Upload your file using the TUS protocol with relevant parameters (language, model, etc.)
  2. Check job status using the session ID returned from upload
  3. Retrieve results once processing is complete

⬆️ Why TUS?​

TUS (https://tus.io/) is an open protocol for resumable file uploads. It ensures:

  • Uploads can resume after a network interruption
  • Large files are handled in chunks
  • Better reliability in flaky network conditions

📘 Learn more about TUS client implementations: https://tus.io/implementations

🔐 Authentication​

To use the Batch API, you’ll need a Batch API key, which you can generate and manage at https://scriptix.app.

All requests must include the following headers:

x-zoom-s2t-key: YOUR_BATCH_API_KEY

For file uploads using TUS, the key must also be included in the initiation request:

POST https://api.scriptix.io/api/v3/files
x-zoom-s2t-key: YOUR_BATCH_API_KEY
Tus-Resumable: 1.0.0
Upload-Metadata: language en,...

🔒 Only the key used to upload the file can be used to check status or retrieve results.

🧪 Quick Start​

WWant to try it out fast? Visit the Quick Start Guide for an overview of authentication and how to choose between Batch and Realtime processing modes.

🕰️ Coming from Batch V1?​

If you’ve previously used our legacy Batch V1 (HTTP POST + session creation), check out the Migration Guide for help transitioning to the TUS-based flow.

🔗 Related Docs​