# HUMAIN Voice Docs

Developer documentation for HUMAIN Voice Arabic and English speech APIs.

## Primary Docs

### en
- [Authentication](https://docs.voice.humain.com/en/authentication): Obtain, store, diagnose, and send a HUMAIN Voice API key.
- [Concepts](https://docs.voice.humain.com/en/concepts): Choose the right speech workflow by input state, result timing, and output type.
- [Introduction](https://docs.voice.humain.com/en): Choose the right HUMAIN Voice workflow, then follow the shortest path to a production-ready integration.
- [Models, Languages, and Voices](https://docs.voice.humain.com/en/models): Choose the right SDK 0.18.0 language, ASR model, processing selector, TTS model, and voice.
- [Quickstart](https://docs.voice.humain.com/en/quickstart): Install SDK 0.18.0, complete a first batch transcription, then choose fast or realtime delivery.
- [Troubleshooting](https://docs.voice.humain.com/en/troubleshooting): Diagnose SDK 0.18.0 connection, mode, audio, finality, result, TTS, rate-limit, and cleanup failures.
- [Batch transcription](https://docs.voice.humain.com/en/api-guides/batch-rest): Submit long complete recordings, poll every terminal state, and handle capacity safely.
- [Errors and rate limits](https://docs.voice.humain.com/en/api-guides/errors-and-rate-limits): Classify failure outcomes, preserve structured evidence, and retry only bounded safe operations.
- [Direct API Overview](https://docs.voice.humain.com/en/api-guides): Choose batch jobs, fast complete-audio, realtime streaming, or TTS for a direct HUMAIN Voice integration.
- [Realtime HTTP](https://docs.voice.humain.com/en/api-guides/realtime-http): Choose complete-audio, live framed, or text-to-speech HTTP operations and handle their streams safely.
- [Realtime Overview](https://docs.voice.humain.com/en/api-guides/realtime): Define live input, choose Socket.IO or HTTP, reconcile result state, and recover conservatively.
- [Socket.IO API](https://docs.voice.humain.com/en/api-guides/socketio): Connect securely and complete fast transcription, live ASR, diarization, voice discovery, or TTS over Socket.IO.
- [Recipes Overview](https://docs.voice.humain.com/en/recipes): Choose an end-to-end HUMAIN Voice task by its input, output, and completion criterion.
- [Transcribe Live Audio](https://docs.voice.humain.com/en/recipes/realtime-transcription): Stream arriving PCM16 audio, reconcile provisional and final text, and export finalized WebVTT with SDK 0.18.0.
- [Generate a Playable WAV File](https://docs.voice.humain.com/en/recipes/text-to-speech-to-file): Discover a voice, synthesize PCM16 with SDK 0.18.0, and package it as a verified WAV artifact.
- [Transcribe a Recording with Speaker Labels](https://docs.voice.humain.com/en/recipes/transcribe-a-recording): Process a complete long-form recording with bounded polling, speaker reconciliation, and subtitle output.
- [SDK Overview](https://docs.voice.humain.com/en/sdk): Choose a HUMAIN Voice SDK 0.18.0 client by workload and server runtime.
- [JavaScript and TypeScript](https://docs.voice.humain.com/en/sdk/javascript): Use @humain-voice/sdk 0.18.0 from a server-side Node.js or Bun runtime.
- [Python](https://docs.voice.humain.com/en/sdk/python): Build Batch, fast, realtime, diarization, and TTS workflows with humain-voice 0.18.0.
- [Fast Transcription](https://docs.voice.humain.com/en/api-guides/asyncapi/fast-transcription): Low-latency transcription over socket.io.
- [Realtime ASR](https://docs.voice.humain.com/en/api-guides/asyncapi/realtime): Stream audio over socket.io for live transcription.
- [Text-to-Speech](https://docs.voice.humain.com/en/api-guides/asyncapi/tts): Stream PCM16 24 kHz audio over socket.io.

### ar
- [المصادقة](https://docs.voice.humain.com/ar/authentication): احصل على مفتاح HUMAIN Voice وخزّنه وشخّصه وأرسله.
- [المفاهيم](https://docs.voice.humain.com/ar/concepts): اختر مسار الكلام المناسب حسب حالة الإدخال وتوقيت النتيجة ونوع الخرج.
- [مقدمة](https://docs.voice.humain.com/ar): اختر مسار HUMAIN Voice المناسب، ثم اتبع أقصر طريق إلى تكامل جاهز للإنتاج.
- [النماذج واللغات والأصوات](https://docs.voice.humain.com/ar/models): اختر لغة SDK 0.18.0 ونموذج ASR ومحدد المعالجة ونموذج TTS والصوت المناسبين.
- [البدء السريع](https://docs.voice.humain.com/ar/quickstart): ثبّت SDK 0.18.0، وأكمل أول نسخ دفعي، ثم اختر التسليم السريع أو الفوري.
- [استكشاف الأخطاء وإصلاحها](https://docs.voice.humain.com/ar/troubleshooting): شخّص إخفاقات الاتصال والوضع والصوت والنهائية والنتائج وTTS وحدود المعدل والتنظيف في SDK 0.18.0.
- [النسخ الدفعي](https://docs.voice.humain.com/ar/api-guides/batch-rest): أرسل تسجيلات طويلة مكتملة، واستعلم عن كل حالة طرفية، وتعامل مع السعة بأمان.
- [الأخطاء وحدود المعدل](https://docs.voice.humain.com/ar/api-guides/errors-and-rate-limits): صنّف نتائج الفشل، واحتفظ بالأدلة المنظمة، وأعد محاولة العمليات الآمنة ضمن حدود فقط.
- [نظرة عامة على API المباشرة](https://docs.voice.humain.com/ar/api-guides): اختر أعمال Batch أو الصوت الكامل السريع أو البث المباشر أو TTS لتكامل HUMAIN Voice مباشر.
- [Realtime HTTP](https://docs.voice.humain.com/ar/api-guides/realtime-http): اختر عمليات HTTP للصوت المكتمل أو المباشر المؤطر أو تحويل النص إلى كلام، وتعامل مع بثها بأمان.
- [نظرة عامة على Realtime](https://docs.voice.humain.com/ar/api-guides/realtime): عرّف الدخل المباشر، واختر Socket.IO أو HTTP، ووفّق حالة النتائج، وتعافَ بصورة محافظة.
- [واجهة Socket.IO](https://docs.voice.humain.com/ar/api-guides/socketio): اتصل بأمان وأكمل النسخ السريع أو ASR المباشر أو التمييز أو اكتشاف الأصوات أو TTS عبر Socket.IO.
- [نظرة عامة على الوصفات](https://docs.voice.humain.com/ar/recipes): اختر مهمة HUMAIN Voice كاملة حسب إدخالها وخرجها ومعيار اكتمالها.
- [النسخ الفوري](https://docs.voice.humain.com/ar/recipes/realtime-transcription): ابث صوت PCM16 عند وصوله، ووفّق النص المؤقت والنهائي، وصدّر WebVTT النهائي باستخدام SDK 0.18.0.
- [توليد ملف WAV قابل للتشغيل](https://docs.voice.humain.com/ar/recipes/text-to-speech-to-file): اكتشف صوتًا، وولد PCM16 باستخدام SDK 0.18.0، وغلّفه في ملف WAV متحقق منه.
- [نسخ تسجيل مع تسميات المتحدثين](https://docs.voice.humain.com/ar/recipes/transcribe-a-recording): عالج تسجيلًا طويلًا ومكتملًا باستعلام محدود، وتوفيق المتحدثين، وخرج التسميات التوضيحية.
- [نظرة SDK العامة](https://docs.voice.humain.com/ar/sdk): اختر عميل HUMAIN Voice SDK 0.18.0 حسب الحمل ووقت تشغيل الخادم.
- [JavaScript وTypeScript](https://docs.voice.humain.com/ar/sdk/javascript): استخدم @humain-voice/sdk 0.18.0 من بيئة Node.js أو Bun على الخادم.
- [Python](https://docs.voice.humain.com/ar/sdk/python): ابنِ مسارات Batch والنسخ السريع والفوري والتمييز وTTS باستخدام humain-voice 0.18.0.
- [مرجع حدث النسخ السريع](https://docs.voice.humain.com/ar/api-guides/asyncapi/fast-transcription): حدث Socket.IO لرفع ملف كامل واستقبال تحديثات نسخ متدفقة.
- [مرجع أحداث Realtime STT](https://docs.voice.humain.com/ar/api-guides/asyncapi/realtime): أحداث Socket.IO للنسخ الفوري وتمييز المتحدثين.
- [مرجع أحداث TTS](https://docs.voice.humain.com/ar/api-guides/asyncapi/tts): أحداث Socket.IO لتحويل النص إلى كلام وبث مقاطع صوتية ثنائية.

## API Reference

### en
- [Direct HTTP API Reference](https://docs.voice.humain.com/en/api-reference): Schema-level reference for Batch and streaming HTTP integrations.
- [Get transcription job status or result (V1 legacy)](https://docs.voice.humain.com/en/api-reference/batch/get-transcription-job-legacy): Legacy compatibility operation used by JavaScript and Python SDK `0.18.0`.
- [Get transcription job status or result (V2)](https://docs.voice.humain.com/en/api-reference/batch/get-transcription-job): Recommended status and result operation for new direct HTTP integrations.
- [Batch API](https://docs.voice.humain.com/en/api-reference/batch): Submit complete long-form recordings, then poll a transcription job to a terminal state.
- [Submit a transcription job](https://docs.voice.humain.com/en/api-reference/batch/submit-transcription-job): Submit one complete recording for asynchronous Batch transcription.
- [Stream fast transcription for one complete audio unit](https://docs.voice.humain.com/en/api-reference/realtime-http/fast-transcription): Transcribe one complete, bounded, latency-sensitive audio unit, such as one finished user turn in an agentic conversation or a voice command.
- [Realtime HTTP API](https://docs.voice.humain.com/en/api-reference/realtime-http): HTTP streaming for bounded Fast input, live audio, diarization, and text-to-speech.
- [Stream Realtime ASR from arriving audio](https://docs.voice.humain.com/en/api-reference/realtime-http/realtime-asr): Canonical direct HTTP operation for Realtime ASR.
- [Build a speaker timeline from arriving audio](https://docs.voice.humain.com/en/api-reference/realtime-http/realtime-diarization): Use this operation to build a speaker timeline while PCM audio is still arriving.
- [Capture an HTTP TTS service-frame stream](https://docs.voice.humain.com/en/api-reference/realtime-http/text-to-speech): This is a direct platform HTTP operation.

### ar
- [مرجع API المباشرة عبر HTTP](https://docs.voice.humain.com/ar/api-reference): مرجع على مستوى المخطط لتكاملات Batch وHTTP المتدفق.
- [جلب حالة عمل النسخ أو نتيجته (V1 القديم)](https://docs.voice.humain.com/ar/api-reference/batch/get-transcription-job-legacy): قراءة V1 للتوافق فقط تستخدمها حزم SDK لـJavaScript وPython في الإصدار 0.18.0؛ استخدم V2 لتكاملات HTTP المباشرة الجديدة.
- [جلب حالة عمل النسخ أو نتيجته (V2)](https://docs.voice.humain.com/ar/api-reference/batch/get-transcription-job): استعلم عن حالة عمل Batch ونتيجته عبر مسار V2 الموصى به للتكاملات المباشرة الجديدة.
- [Batch API](https://docs.voice.humain.com/ar/api-reference/batch): أرسل تسجيلات طويلة ومكتملة، ثم استعلم عن عمل النسخ حتى يصل إلى حالة نهائية.
- [إرسال مهمة نسخ](https://docs.voice.humain.com/ar/api-reference/batch/submit-transcription-job): أرسل تسجيلًا مكتملًا وطويلًا للمعالجة غير المتزامنة، ثم خزّن معرّف المهمة.
- [بث النسخ السريع لوحدة صوت مكتملة](https://docs.voice.humain.com/ar/api-reference/realtime-http/fast-transcription): ارفع وحدة صوت مكتملة ومحدودة، مثل دور وكيل، واستقبل تحديثات النسخ المتدفقة.
- [واجهة Realtime HTTP](https://docs.voice.humain.com/ar/api-reference/realtime-http): عمليات HTTP مباشرة لوحدة Fast المكتملة والصوت الذي ما زال يصل وتمييز المتحدثين وتسجيل بروتوكول TTS.
- [بث ASR مباشر من صوت ما زال يصل](https://docs.voice.humain.com/ar/api-reference/realtime-http/realtime-asr): أرسل إطارات PCM16 متسلسلة واستقبل صفرًا أو أكثر من نتائج النسخ الجزئية والنهائية لكل طلب.
- [بناء خط زمني للمتحدثين من صوت ما زال يصل](https://docs.voice.humain.com/ar/api-reference/realtime-http/realtime-diarization): أرسل إطارات PCM16 متسلسلة لكل UUID ووفّق إضافات المقاطع النهائية مع اللقطة النشطة.
- [التقاط تدفق إطارات خدمة TTS عبر HTTP](https://docs.voice.humain.com/ar/api-reference/realtime-http/text-to-speech): أرسل نصًا واحفظ تسجيل بروتوكول ثنائي بلا فواصل بتردد 16 kHz؛ الاستجابة ليست PCM أو WAV قابلاً للتشغيل.

## Markdown Access
- [Full Markdown bundle](https://docs.voice.humain.com/llms-full.txt)
- English hand-written docs use https://docs.voice.humain.com/en/md/%3Cslug%3E
- Arabic hand-written docs use https://docs.voice.humain.com/ar/md/%3Cslug%3E
- English API reference docs use https://docs.voice.humain.com/en/api-reference/md/%3Cslug%3E
- Arabic API reference docs use https://docs.voice.humain.com/ar/api-reference/md/%3Cslug%3E