🧭 Scriptix API Overview
Scriptix offers a flexible API suite for building powerful speech-to-text workflows. Whether you’re processing large archives of recordings or streaming live audio, the APIs are built to scale with your needs.
⚙️ API Categories
| API Type | Purpose | Docs |
|---|---|---|
| Batch | Asynchronous file upload & transcription | Docs |
| Realtime | Live audio transcription over WebSocket | Docs |
| Documents | Manage jobs, metadata, translation & webhooks | Docs |
| Custom Models | Train and use domain-specific AI models | Docs |
| Reseller | Manage customers, tokens, and usage | Docs |
🔁 Common Integration Flow
- Authenticate – Use token-based auth (reseller or customer)
- Upload or Stream – Depending on your use case
- Track Progress – Use the Documents API or Webhooks
- Enhance – Translate, review, and share your transcripts
🧱 Base URL
The base URL for all Scriptix APIs is:
https://api.scriptix.dev/api/v3
🔍 Versioning
We currently support:
v2– Recommended for new integrationsv1– Legacy endpoints (still supported but being phased out)
📘 Explore version changes in the Migration Guide
📦 Batch API (v1 and v2)
The Batch API allows you to process audio asynchronously through three key steps:
- Initiate a session by specifying the desired language model
- Upload your audio file or provide a downloadable URL
- Check processing status and retrieve results
🧠 Two Options Available
-
v1 – HTTP POST Upload: Upload files directly with the session request. Used for simple integrations and small files.
-
v2 – TUS Upload Support: The TUS protocol allows resumable, chunked uploads—ideal for large or unstable connections. Learn more about TUS at tus.io and its client libraries.
🔐 Make sure you have a Batch API token. You can create one at Dashboard Api Keys