Skip to main content

🔐 Authentication

All Scriptix APIs authenticate with a single header:

HeaderValueNotes
x-zoom-s2t-key<your_api_key>Required for all API communication

Where to get your API key​

Create and manage API tokens in the Scriptix Dashboard. When creating a token, choose the type that matches your integration:

  • Batch — for file-based processing over HTTPS using TUS
  • Realtime — for streaming over WebSocket

Use the token’s key value in the x-zoom-s2t-key header.

TUS protocol details: tus.io • Client implementations: tus.io/implementations

🔒 Security​

  • Keep tokens secret (do not expose in frontend code or repos).
  • Store tokens in server-side environment variables.
  • Rotate or revoke tokens as needed.

🔑 Token Types​

There are two types of API tokens in the Scriptix ecosystem:

1. Reseller Token​

Used by partners who manage multiple customers. With a reseller token, you can:

  • Create and manage customers
  • Generate individual customer tokens
  • Track usage across your client base

2. Customer Token​

Issued by resellers and tied to an individual customer or integration. Use this token when uploading or streaming audio on behalf of a specific customer.

💡 Best Practice: Always use customer tokens for end-user transcription jobs to ensure clean usage tracking.

info

You can generate tokens via the Scriptix Dashboard.

🖼️ Example: API Keys Page​

API Keys Page Screenshot

🔐 Managing Your Tokens​

You can create and manage your API tokens in:

  • API Keys — create batch or realtime tokens.
  • Reseller Dashboard > Customers, open the API Keys tab. Pattern: https://scriptix.app/reseller/<customer_id>?tab=2

Example: scriptix.app/reseller/12345?tab=2​

🔒 Security Best Practices​

  • Keep tokens secret: Treat them like passwords. Never expose them in frontend code or public repos.
  • Use environment variables: Store and load tokens securely in your backend or CI/CD environments.
  • Rotate tokens: Regularly regenerate and update tokens to minimize long-term risk.
  • Use one token per customer: It ensures clean billing and debugging.
  • Set appropriate permissions (when supported): Limit token scope to the minimum necessary actions.

✅ Next Steps​

Need help? Reach out to support via the dashboard or your account manager.