# Hamsa API

## Docs

- [Introduction](https://nadsoft.mintlify.app/introduction.md): Welcome to Hamsa API docs! Build with our robust media-to-text APIs
- [Authentication](https://nadsoft.mintlify.app/auth.md): To use the transcription API, you need to authenticate your requests.
- [Create API Keys](https://nadsoft.mintlify.app/create-api-keys.md): This page shows you how to use Hamsa Dashboard to create new API keys.
- [Webhook Integration Guide](https://nadsoft.mintlify.app/webhook-integration-guide.md): Complete guide to integrating with Hamsa Voice Agent webhooks - from setup to production deployment
- [Introduction](https://nadsoft.mintlify.app/api-reference/introduction.md): API documentation for the Hamsa API
- [Voice Agents SDK](https://nadsoft.mintlify.app/api-reference/voice-agents-sdk.md): Welcome to Voice Agents SDK documentation page!
- [Voice Enablement](https://nadsoft.mintlify.app/api-reference/voice-enablement.md): Welcome to Voice Enablement documentation page!
- [Transcribe Route](https://nadsoft.mintlify.app/api-reference/endpoint/transcribe.md)
- [Preload Cloned TTS Voice into the System](https://nadsoft.mintlify.app/api-reference/endpoint/preload-cloned-tts-voice.md): This endpoint allows you to preload a custom cloned voice into the system's before using it. You only need to preload the voice only once. You may preload it once your application starts to reduce any latency if you use the Real-Time APIs.
- [Generate Text to Speech Route](https://nadsoft.mintlify.app/api-reference/endpoint/generate-tts.md)
- [Generate Text to Speech File Data](https://nadsoft.mintlify.app/api-reference/endpoint/rt-generate-tts.md)
- [Generate Streamed Text to Speech File Data](https://nadsoft.mintlify.app/api-reference/endpoint/rt-generate-tts-stream.md): From the user's perspective, this is a standard request. In the response, we include specific headers: 'Transfer-Encoding' is set to 'chunked' to enable streaming, 'Connection' is set to 'keep-alive' to maintain the connection, and 'Content-Type' is set to 'audio/wav' to indicate the media type. The…
- [Generate Speech to Text Transcription](https://nadsoft.mintlify.app/api-reference/endpoint/rt-generate-stt.md)
- [Add Phone Number to a User Route](https://nadsoft.mintlify.app/api-reference/endpoint/add-phone-number.md)
- [Get Phone Number by its ID Route](https://nadsoft.mintlify.app/api-reference/endpoint/get-phone-number.md)
- [Assign Phone Number to a Voice Agent Route](https://nadsoft.mintlify.app/api-reference/endpoint/assign-phone-number.md)
- [Unassign Phone Number to a Voice Agent Route](https://nadsoft.mintlify.app/api-reference/endpoint/unassign-phone-number.md)
- [List User Phone Numbers Route](https://nadsoft.mintlify.app/api-reference/endpoint/list-phone-numbers.md)
- [Create an Outbound Call](https://nadsoft.mintlify.app/api-reference/endpoint/call-phone-number.md)
- [Create Voice Agent Route](https://nadsoft.mintlify.app/api-reference/endpoint/create-voice-agent.md): Create a new voice agent to start using our powerful and robust voice assistant feature. This route requires an API key for authentication.
- [Clone Voice Agent Route](https://nadsoft.mintlify.app/api-reference/endpoint/clone-voice-agent.md): Use this route to clone an existing agent. You can use it to clone one of the voice agents templates created by our experts!
- [Update Voice Agent Route](https://nadsoft.mintlify.app/api-reference/endpoint/update-voice-agent.md)
- [Get Voice Agents List Route](https://nadsoft.mintlify.app/api-reference/endpoint/get-all-voice-agents.md)
- [Get A Voice Agent By Id Route](https://nadsoft.mintlify.app/api-reference/endpoint/get-voice-agent-by-id.md)
- [Get Voice Agent Templates Route](https://nadsoft.mintlify.app/api-reference/endpoint/get-voice-agent-templates.md): Use this route to get the voice agent templates created by our experts. You can take the template id and use clone voice agent route to create a new voice agent based on the template.
- [Start a Call for a Conversation Route](https://nadsoft.mintlify.app/api-reference/endpoint/start-a-call.md)
- [Create AI Content Route](https://nadsoft.mintlify.app/api-reference/endpoint/post-ai-content.md)
- [Get AI Content Route](https://nadsoft.mintlify.app/api-reference/endpoint/get-ai-content.md)
- [Create Customized AI Content Route](https://nadsoft.mintlify.app/api-reference/endpoint/custom-ai-content.md): Generates AI content based on the specified transcription job ID and parameters.
- [Get AI Content Cost Estimate Route](https://nadsoft.mintlify.app/api-reference/endpoint/ai-content-estimate.md): Returns the estimated cost for the specified AI content job.
- [Get Jobs List](https://nadsoft.mintlify.app/api-reference/endpoint/get-jobs-list.md)
- [Get Job Details By Id](https://nadsoft.mintlify.app/api-reference/endpoint/get-job-by-id.md)
- [Get Project By API Key](https://nadsoft.mintlify.app/api-reference/endpoint/get-project-by-api-key.md)
- [Get Usage Statistics Numbers](https://nadsoft.mintlify.app/api-reference/endpoint/statistics-numbers.md)
- [Get Usage Statistics Chart](https://nadsoft.mintlify.app/api-reference/endpoint/statistics-chart.md)

## OpenAPI Specs

- [openapi](https://nadsoft.mintlify.app/api-reference/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.