# Hamsa API ## Docs - [Introduction](https://docs.tryhamsa.com/overview/introduction.md): Build powerful AI voice agents and leverage advanced media APIs with Hamsa - [Models](https://docs.tryhamsa.com/overview/models.md): Learn about the models that power the Hamsa API - [Limits and Usage](https://docs.tryhamsa.com/overview/limits-and-usage.md): How plan credits, usage limits, and concurrency limits work across Hamsa services - [Quick Start](https://docs.tryhamsa.com/overview/quickstart.md): Build your first voice agent in 10 minutes - [Authentication](https://docs.tryhamsa.com/overview/auth.md): To use the transcription API, you need to authenticate your requests. - [Text to Speech](https://docs.tryhamsa.com/overview/capabilities/text-to-speech.md): Convert text into natural-sounding Arabic and English speech - [Speech to Text](https://docs.tryhamsa.com/overview/capabilities/speech-to-text.md): Transcribe Arabic and English speech into accurate text - [Voice Agents](https://docs.tryhamsa.com/overview/capabilities/voice-agents.md): Build intelligent AI voice agents for phone calls in Arabic and English - [Voices](https://docs.tryhamsa.com/overview/features/voices.md): Select from a diverse library of AI voices to give your agents the perfect personality and tone - [Voice Cloning](https://docs.tryhamsa.com/overview/features/voice-cloning.md): Create custom AI voices unique to your brand from audio samples - [Projects Overview](https://docs.tryhamsa.com/overview/projects/overview.md): Organize your work and collaborate with your team using projects - [Managing Projects](https://docs.tryhamsa.com/overview/projects/managing-projects.md): Create, rename, and manage the lifecycle of your projects - [Team Collaboration](https://docs.tryhamsa.com/overview/projects/team-collaboration.md): Invite teammates to your project and manage your team members - [Roles & Permissions](https://docs.tryhamsa.com/overview/projects/roles-and-permissions.md): Understand what each role can do and how owners can customize member access - [Overview](https://docs.tryhamsa.com/overview/account-settings/overview.md): Manage your profile, security, and notification preferences - [Profile Settings](https://docs.tryhamsa.com/overview/account-settings/profile-settings.md): Manage your personal and company information - [Security Settings](https://docs.tryhamsa.com/overview/account-settings/security-settings.md): Manage passwords and account security - [Notification Settings](https://docs.tryhamsa.com/overview/account-settings/notification-settings.md): Control email notification preferences - [Account Creation](https://docs.tryhamsa.com/overview/account-settings/account-creation.md): Learn how to create and set up your account - [Create API Keys](https://docs.tryhamsa.com/overview/create-api-keys.md): This page shows you how to use Hamsa Dashboard to create new API keys. - [Troubleshooting Guide](https://docs.tryhamsa.com/overview/troubleshooting.md): Common issues, solutions, and debugging strategies for Hamsa Telephony agents - [Text to Speech](https://docs.tryhamsa.com/text-to-speech/introduction.md): Convert text into natural-sounding Arabic and English speech with Hamsa TTS - [Quickstart](https://docs.tryhamsa.com/text-to-speech/quickstart.md): Convert text into lifelike speech - [Voices](https://docs.tryhamsa.com/text-to-speech/voices.md): Browse and select AI voices for your agents from our extensive voice library - [Voice Cloning](https://docs.tryhamsa.com/text-to-speech/voice-cloning.md): Create custom AI voices from your own audio samples - [Speech to Text](https://docs.tryhamsa.com/speech-to-text/introduction.md): Transcribe Arabic and English speech into accurate text with Hamsa STT - [Quickstart](https://docs.tryhamsa.com/speech-to-text/quickstart.md): Transcribe your first audio file - [Real-time Transcription](https://docs.tryhamsa.com/speech-to-text/real-time.md): Stream audio for low-latency transcription - [Supported Languages](https://docs.tryhamsa.com/speech-to-text/guides/supported-languages.md): Languages supported by Speech to Text models - [Improving Accuracy](https://docs.tryhamsa.com/speech-to-text/guides/improving-accuracy.md): Best practices for high-quality transcription - [Introduction](https://docs.tryhamsa.com/agents/dashboard/introduction.md): Centralized monitoring interface for tracking system activity, performance, and customer satisfaction - [Overview](https://docs.tryhamsa.com/agents/dashboard/overview.md): Monitor your voice AI system's overall activity with session counts, durations, and call distribution analytics - [Performance](https://docs.tryhamsa.com/agents/dashboard/performance.md): Monitor your voice AI agent's performance with metrics on speech processing, LLM response times, latency, and error rates - [Satisfaction & Outcome](https://docs.tryhamsa.com/agents/dashboard/satisfaction.md): Track customer satisfaction metrics including CSAT scores, NPS, sentiment analysis, first-call resolution rates, and escalation patterns - [Live Calls](https://docs.tryhamsa.com/agents/dashboard/live-calls.md): Monitor active calls in real-time, join conversations as a silent listener, and view live transcription - [Voice Agents](https://docs.tryhamsa.com/agents/introduction.md): Build intelligent AI voice agents for phone and web - [Single Prompt Agent Overview](https://docs.tryhamsa.com/agents/single-prompt/overview.md): Simple, fast, and effective for straightforward conversational scenarios - [Writing Effective Prompts](https://docs.tryhamsa.com/agents/single-prompt/write-prompt.md): How to write the preamble (system prompt) for your single prompt agent - [Call Behavior Settings](https://docs.tryhamsa.com/agents/single-prompt/call-behavior.md): Configure response timing, interruptions, inactivity handling, and call duration for your single prompt agent - [Voice Settings](https://docs.tryhamsa.com/agents/single-prompt/voice-settings.md): Configure the voice, language, and dialect for your single prompt agent - [Intelligence Features](https://docs.tryhamsa.com/agents/single-prompt/intelligence-features.md): Advanced AI capabilities including gender detection, smart call end, speaker identification, agentic RAG, and language dialect switcher - [Configure Settings](https://docs.tryhamsa.com/agents/single-prompt/configure-settings.md): Overview of all configuration settings for single prompt agents - [Flow Agent Overview](https://docs.tryhamsa.com/agents/flow-agent/overview.md): Build sophisticated conversation flows with visual node-based editor - [Global Settings](https://docs.tryhamsa.com/agents/flow-agent/global-settings.md): Configure agent-level defaults for voice, LLM, knowledge base, and call behavior - [Global Nodes](https://docs.tryhamsa.com/agents/flow-agent/global-nodes.md): Create nodes accessible from anywhere in the flow via natural language or DTMF - [Transitions](https://docs.tryhamsa.com/agents/flow-agent/transitions.md): Control conversation flow with natural language, equations, DTMF, and auto transitions - [DTMF Features](https://docs.tryhamsa.com/agents/flow-agent/dtmf.md): Three DTMF features for keypad interaction in voice agents - [Debugging & Validation](https://docs.tryhamsa.com/agents/flow-agent/debugging.md): Validation system, testing flows, troubleshooting common issues, and debugging tools - [Best Practices](https://docs.tryhamsa.com/agents/flow-agent/best-practices.md): Guidance for building reliable flow agents - [Node Types Overview](https://docs.tryhamsa.com/agents/flow-agent/nodes/overview.md): Complete guide to all Flow Agent node types and when to use each - [Start Node](https://docs.tryhamsa.com/agents/flow-agent/nodes/start-node.md): Flow entry point with dual modes: conversation or tool execution - [Conversation Node](https://docs.tryhamsa.com/agents/flow-agent/nodes/conversation-node.md): Natural dialogue with users - the most commonly used node type - [Router Node](https://docs.tryhamsa.com/agents/flow-agent/nodes/router-node.md): Conditional routing based on variables and equations without conversation - [Tool Node](https://docs.tryhamsa.com/agents/flow-agent/nodes/tool-node.md): Execute reusable tool templates with parameter mapping and error handling - [Web Tool Node](https://docs.tryhamsa.com/agents/flow-agent/nodes/web-tool-node.md): Execute client-side browser tools within your flow with output mapping and conditional routing - [Transfer Call Node](https://docs.tryhamsa.com/agents/flow-agent/nodes/transfer-call-node.md): Transfer phone calls to another number with warm or cold handoff options - [Transfer Agent Node](https://docs.tryhamsa.com/agents/flow-agent/nodes/transfer-agent-node.md): Seamlessly transfer to another Hamsa AI agent while preserving conversation context - [End Call Node](https://docs.tryhamsa.com/agents/flow-agent/nodes/end-call-node.md): Gracefully terminate calls with customizable farewell messages - [Set Local Variables Node](https://docs.tryhamsa.com/agents/flow-agent/nodes/set-local-variables-node.md): Set variable values without conversation, then automatically advance to the next node - [Change Agent Settings Node](https://docs.tryhamsa.com/agents/flow-agent/nodes/change-agent-settings-node.md): Override agent settings mid-flow — voice, call behavior, system prompt, and more - [Publish agent](https://docs.tryhamsa.com/agents/publishing/publish-agent.md): Turn any agent into a public page that anyone can open in a browser and talk to — no sign-in required. - [Embed on your website](https://docs.tryhamsa.com/agents/publishing/embed.md): Add your published agent to your own website as a floating widget. - [Variable System Overview](https://docs.tryhamsa.com/agents/variables/introduction.md): Variables for flow builder and single-prompt agents—overview, quick start, and architecture - [System Variables](https://docs.tryhamsa.com/agents/variables/system-variables.md): Platform-provided variables for time, call, user, and agent - [Custom Variables](https://docs.tryhamsa.com/agents/variables/custom-variables.md): Workflow-level variables for flow and single-prompt agents - [Extracted Variables](https://docs.tryhamsa.com/agents/variables/extracted-variables.md): AI, toolpath, and DTMF extraction in flow agents - [Static Variables (Local Variables)](https://docs.tryhamsa.com/agents/variables/static-variables.md): Node-level variables with fixed or templated values in flow agents - [Availability & Context](https://docs.tryhamsa.com/agents/variables/availability-and-context.md): Where variables are available in flow and single-prompt agents - [Template Syntax & Naming](https://docs.tryhamsa.com/agents/variables/syntax-and-naming.md): Variable reference syntax and naming rules - [UI Components & Validation](https://docs.tryhamsa.com/agents/variables/ui-and-validation.md): Variables panel, inputs, builders, and validation - [Advanced Features](https://docs.tryhamsa.com/agents/variables/advanced.md): Nested data, enums, path selector, and technical architecture - [Practical Examples](https://docs.tryhamsa.com/agents/variables/examples.md): Example flows using variables—booking, routing, DTMF, tool testing, web tools, single-prompt agent - [Best Practices](https://docs.tryhamsa.com/agents/variables/best-practices.md): Guidance for working with variables - [Troubleshooting](https://docs.tryhamsa.com/agents/variables/troubleshooting.md): Common variable and tool-testing issues - [API Reference & Migration](https://docs.tryhamsa.com/agents/variables/api-reference.md): Variable schemas, file locations, and migration from legacy - [Tools](https://docs.tryhamsa.com/agents/tools/introduction.md): Extend your agent with server-side API calls, MCP integrations, and client-side web tools - [Function Tools](https://docs.tryhamsa.com/agents/tools/function-tools.md): Make server-side API calls during conversations to extend your agent with external data and actions - [MCP Tools](https://docs.tryhamsa.com/agents/tools/mcp-tools.md): Connect to Model Context Protocol servers for external service integrations - [Web Tools](https://docs.tryhamsa.com/agents/tools/web-tools.md): Client-side JavaScript functions that let your agent interact with your web application - [Quick Start](https://docs.tryhamsa.com/agents/knowledge-base/quick-start.md): Get started with Knowledge Base in 4 simple steps - [Overview](https://docs.tryhamsa.com/agents/knowledge-base/introduction.md): Comprehensive content management for Voice Agents with text, file, and URL support - [Overview](https://docs.tryhamsa.com/agents/knowledge-base/creating-items.md): Step-by-step guide to creating text, file, and URL items - [Text Items](https://docs.tryhamsa.com/agents/knowledge-base/creating-items/text-items.md): Create text items by entering content directly into the platform - [File Items](https://docs.tryhamsa.com/agents/knowledge-base/creating-items/file-items.md): Upload documents to add to your knowledge base - [URL Items](https://docs.tryhamsa.com/agents/knowledge-base/creating-items/url-items.md): Import web content from URLs and sitemaps - [Managing Items](https://docs.tryhamsa.com/agents/knowledge-base/managing-items.md): Organize, search, filter, and manage your items - [Status Lifecycle and Processing](https://docs.tryhamsa.com/agents/knowledge-base/status-lifecycle.md): Understand item processing states, status tracking, and error handling - [Best Practices](https://docs.tryhamsa.com/agents/knowledge-base/best-practices.md): Guidance for structuring and maintaining your knowledge base - [Quick Start](https://docs.tryhamsa.com/agents/batch-calls/quick-start.md): Get started with Batch Calls in 5 simple steps - [Overview](https://docs.tryhamsa.com/agents/batch-calls/introduction.md): Batch outbound calls executed by Voice Agents with scheduling and recipient management - [Creating Batch Calls](https://docs.tryhamsa.com/agents/batch-calls/creating-batch-calls.md): Step-by-step guide to creating batch calls, uploading recipients, and configuring schedules - [Managing Batch Calls](https://docs.tryhamsa.com/agents/batch-calls/managing-batch-calls.md): Schedule, control, and monitor batch call execution with pause, resume, retry, and cancel actions - [Recipients & Status](https://docs.tryhamsa.com/agents/batch-calls/recipients-status.md): Manage recipients, track call statuses, and understand call outcomes - [Best Practices](https://docs.tryhamsa.com/agents/batch-calls/best-practices.md): Guidance for running batch calls effectively - [Quick Start](https://docs.tryhamsa.com/agents/call-history/quick-start.md): Get started with Call History in 4 simple steps - [Overview](https://docs.tryhamsa.com/agents/call-history/introduction.md): Comprehensive tracking and management of all voice conversations with filtering, search, and export - [Viewing Calls](https://docs.tryhamsa.com/agents/call-history/viewing-calls.md): Filter, search, sort, and paginate call history with comprehensive controls - [Call Details](https://docs.tryhamsa.com/agents/call-history/call-details.md): Comprehensive call information with overview, conversation, logs, and outcomes - [Best Practices](https://docs.tryhamsa.com/agents/call-history/best-practices.md): Guidance for working with call history effectively - [Quick Start](https://docs.tryhamsa.com/agents/phone-numbers/quick-start.md): Get started with Phone Numbers in 4 simple steps - [Overview](https://docs.tryhamsa.com/agents/phone-numbers/introduction.md): Comprehensive phone number management with multi-provider support and voice agent integration - [Managing Phone Numbers](https://docs.tryhamsa.com/agents/phone-numbers/managing-numbers.md): Comprehensive guide to adding, configuring, assigning, and deleting phone numbers - [Making Outbound Calls](https://docs.tryhamsa.com/agents/phone-numbers/making-calls.md): Learn how to make outbound calls using your phone numbers and Voice Agents - [Best Practices](https://docs.tryhamsa.com/agents/phone-numbers/best-practices.md): Guidance for managing phone numbers effectively - [Configuring Webhooks in Dashboard](https://docs.tryhamsa.com/agents/webhooks/introduction.md): Set up webhook endpoints for your AI agents using the Hamsa dashboard - [Telephony Dashboard Guide](https://docs.tryhamsa.com/agents/telephony/introduction.md): Manage phone numbers using the Hamsa dashboard - [Testing Dashboard Guide](https://docs.tryhamsa.com/agents/testing/introduction.md): Test and debug agents using the Hamsa dashboard - [Media Platform Introduction](https://docs.tryhamsa.com/media/introduction.md): Comprehensive media processing platform for transcription, voice synthesis, and AI content generation - [Overview](https://docs.tryhamsa.com/media/speech-to-text/overview.md): Convert audio and video content into structured, editable text transcripts - [Creating Transcriptions](https://docs.tryhamsa.com/media/speech-to-text/creating-transcriptions.md): Step-by-step guide to creating transcription jobs from files, YouTube links, or recordings - [Managing Transcripts](https://docs.tryhamsa.com/media/speech-to-text/managing-transcripts.md): Organize, search, filter, and manage your transcription jobs - [Speaker Management](https://docs.tryhamsa.com/media/speech-to-text/speaker-management.md): Identify, organize, and manage speakers in your transcripts - [Export Options](https://docs.tryhamsa.com/media/speech-to-text/export-options.md): Export transcripts in multiple formats for different use cases - [Overview](https://docs.tryhamsa.com/media/text-to-speech/overview.md): Convert written content into human-like audio using configurable voice models - [Creating TTS Jobs](https://docs.tryhamsa.com/media/text-to-speech/creating-jobs.md): Step-by-step guide to creating text-to-speech jobs - [Voice Selection](https://docs.tryhamsa.com/media/text-to-speech/voice-selection.md): Choose and customize voices for text-to-speech generation - [Voice Controls](https://docs.tryhamsa.com/media/text-to-speech/voice-controls.md): Adjust speed, expressiveness, and other voice parameters - [Managing Jobs](https://docs.tryhamsa.com/media/text-to-speech/managing-jobs.md): Organize, view, and manage your text-to-speech jobs - [Overview](https://docs.tryhamsa.com/media/ai-docs/overview.md): Generate structured written content from transcripts using AI-powered templates - [Creating Jobs](https://docs.tryhamsa.com/media/ai-docs/creating-jobs.md): Step-by-step guide to creating AI Docs jobs from transcripts - [Managing Content](https://docs.tryhamsa.com/media/ai-docs/managing-content.md): Organize, edit, and manage your AI Docs jobs - [Quick Start](https://docs.tryhamsa.com/developers/apis/quick-start.md): Complete guide to integrating with all Hamsa APIs - authentication, REST endpoints, real-time APIs, SDKs, and webhooks - [Hamsa Voice Agents Web SDK](https://docs.tryhamsa.com/developers/sdks/voice-agents-web-sdk.md): JavaScript SDK for integrating voice agents into web applications - [API Integration Guide](https://docs.tryhamsa.com/developers/apis/api-integration.md): Build integrations with the Hamsa API - [Using Custom Cloned Voices](https://docs.tryhamsa.com/developers/apis/use-cloned-voice-id-as-speaker.md): Learn how to preload and use your custom cloned voices with Hamsa Real-Time APIs - [UneeQ Digital Human Integration](https://docs.tryhamsa.com/developers/apis/uneeq-integration.md): Use Hamsa TTS voices to power UneeQ digital human avatars via the custom voice endpoint - [Live kit plugin](https://docs.tryhamsa.com/developers/agent-guides/live-kit-plugin.md) - [Prompt Engineering Guide](https://docs.tryhamsa.com/developers/agent-guides/prompt-engineering.md): Write effective prompts for voice AI agents - [Webhook Integration - Developer Guide](https://docs.tryhamsa.com/developers/agent-guides/webhook-integration-guide.md): Build robust webhook handlers to process Hamsa voice agent events - [Call Routing Guide](https://docs.tryhamsa.com/developers/agent-guides/call-routing.md): Advanced routing patterns with router nodes, conditions, and intelligent call distribution - [Data Collection Guide](https://docs.tryhamsa.com/developers/agent-guides/data-collection.md): Collect information with DTMF input capture, variables, and natural language extraction - [Building IVR Menus](https://docs.tryhamsa.com/developers/agent-guides/ivr-menus.md): Create interactive voice response menus with DTMF - [Introduction](https://docs.tryhamsa.com/api-reference/introduction.md): API documentation for the Hamsa API - [Transcribe Route](https://docs.tryhamsa.com/api-reference/endpoint/transcribe.md) - [Create Speech to Text](https://docs.tryhamsa.com/api-reference/endpoint/create-job-v2.md): Create a transcription job. - [Generate Text to Speech Route](https://docs.tryhamsa.com/api-reference/endpoint/generate-tts.md) - [Preload Cloned TTS Voice](https://docs.tryhamsa.com/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. - [Create TTS history](https://docs.tryhamsa.com/api-reference/create-tts-history.md): Create a new TTS history entry for a generated audio clip. - [List TTS histories](https://docs.tryhamsa.com/api-reference/list-tts-histories.md): List TTS history entries with pagination. - [Get TTS history](https://docs.tryhamsa.com/api-reference/get-tts-history.md): Retrieve a single TTS history entry by ID. - [Delete TTS history](https://docs.tryhamsa.com/api-reference/delete-tts-history.md): Delete a TTS history entry by ID. - [Generate Text to Speech File Data](https://docs.tryhamsa.com/api-reference/endpoint/rt-generate-tts.md) - [Generate Streamed Text to Speech File Data](https://docs.tryhamsa.com/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://docs.tryhamsa.com/api-reference/endpoint/rt-generate-stt.md) - [Add Phone Number to a User Route](https://docs.tryhamsa.com/api-reference/endpoint/add-phone-number.md) - [Get Phone Number by its ID Route](https://docs.tryhamsa.com/api-reference/endpoint/get-phone-number.md) - [Delete Phone Number](https://docs.tryhamsa.com/api-reference/endpoint/delete-phone-number.md): Removes a phone number from the user's account. - [Assign Phone Number to a Voice Agent Route](https://docs.tryhamsa.com/api-reference/endpoint/assign-phone-number.md) - [Unassign Phone Number to a Voice Agent Route](https://docs.tryhamsa.com/api-reference/endpoint/unassign-phone-number.md) - [List User Phone Numbers Route](https://docs.tryhamsa.com/api-reference/endpoint/list-phone-numbers.md) - [Create an Outbound Call](https://docs.tryhamsa.com/api-reference/endpoint/call-phone-number.md) - [Clone Voice Agent Route](https://docs.tryhamsa.com/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! - [Create Voice Agent](https://docs.tryhamsa.com/api-reference/endpoint/create-voice-agent-v2.md): Creates a new voice agent using the V2 API with enhanced configuration options. - [List Voice Agents](https://docs.tryhamsa.com/api-reference/endpoint/list-voice-agents-v2.md): Retrieves a paginated list of voice agents with filtering and sorting options. - [Get Voice Agent](https://docs.tryhamsa.com/api-reference/endpoint/get-voice-agent-v2.md): Retrieves a specific voice agent by its unique identifier. - [Update Voice Agent](https://docs.tryhamsa.com/api-reference/endpoint/update-voice-agent-v2.md): Updates an existing voice agent with new configuration. - [List TTS voices](https://docs.tryhamsa.com/api-reference/list-tts-voices.md): Retrieve available TTS voices with optional filtering, pagination, and source flags. - [Create TTS voice](https://docs.tryhamsa.com/api-reference/create-tts-voice.md): Create a new TTS voice under the current project. - [List dialects](https://docs.tryhamsa.com/api-reference/list-dialects.md): Retrieve available dialects for TTS voices. - [Favorite a TTS voice](https://docs.tryhamsa.com/api-reference/favorite-a-tts-voice.md): Mark or unmark a TTS voice as Favorite. - [Delete TTS voice](https://docs.tryhamsa.com/api-reference/delete-tts-voice.md): Delete an existing TTS voice. - [Get TTS voice](https://docs.tryhamsa.com/api-reference/get-tts-voice.md): Retrieve a single TTS voice by ID. - [Preview TTS voice](https://docs.tryhamsa.com/api-reference/preview-tts-voice.md): Generate a short preview clip for a TTS voice. - [Get default TTS voice](https://docs.tryhamsa.com/api-reference/get-default-tts-voice.md): Retrieve the default TTS voice for the current language. - [Extract transcription from voice audio](https://docs.tryhamsa.com/api-reference/extract-transcription-from-voice-audio.md): Extract a text transcription from a voice audio sample. - [List Call Records (Minimal)](https://docs.tryhamsa.com/api-reference/endpoint/list-minimal-calls.md): Returns a paginated, lightweight list of voice-agent call records for a project. Each row carries only the fields needed for dashboard timelines (id, createdAt, status, agent, duration, channel, phone numbers). Filter by voice agent, one-or-many statuses, and a UTC time range on `createdAt`. - [Get Conversation by ID](https://docs.tryhamsa.com/api-reference/endpoint/get-conversation.md): Retrieves detailed information about a specific conversation including call logs, performance metrics, and associated voice agent configuration. - [Terminate Conversation](https://docs.tryhamsa.com/api-reference/endpoint/terminate-conversation.md): Terminates an active or pending conversation and closes the associated LiveKit room. - [Create Campaign](https://docs.tryhamsa.com/api-reference/endpoint/create-campaign.md): Creates a new outbound campaign with specified recipients, voice agent, and scheduling configuration. - [List Campaigns](https://docs.tryhamsa.com/api-reference/endpoint/list-campaigns.md): Retrieves a paginated list of campaigns with optional filtering by voice agent and search query. - [Get Campaign by ID](https://docs.tryhamsa.com/api-reference/endpoint/get-campaign.md): Retrieves a specific campaign by ID with recipients grouped by status (pending, queued, in-progress, completed, failed, no-answer). - [Update Campaign Name](https://docs.tryhamsa.com/api-reference/endpoint/update-campaign.md): Updates the name of an existing campaign by ID. - [Delete Campaign](https://docs.tryhamsa.com/api-reference/endpoint/delete-campaign.md): Soft deletes a campaign by ID. The campaign will be marked as deleted but not permanently removed from the database. - [Cancel Campaign](https://docs.tryhamsa.com/api-reference/endpoint/cancel-campaign.md): Cancels a running or scheduled campaign. Once cancelled, the campaign cannot be restarted. - [Retry Campaign](https://docs.tryhamsa.com/api-reference/endpoint/retry-campaign.md): Retries failed or no-answer recipients in a campaign. Only recipients with FAILED or NO_ANSWER status will be retried. - [Pause Campaign](https://docs.tryhamsa.com/api-reference/endpoint/pause-campaign.md): Pauses a running or scheduled campaign. Paused campaigns can be resumed later. - [Resume Campaign](https://docs.tryhamsa.com/api-reference/endpoint/resume-campaign.md): Resumes a previously paused campaign. - [Create Voice Dictionary](https://docs.tryhamsa.com/api-reference/endpoint/create-voice-dictionary.md): Creates a new voice dictionary with custom pronunciation rules. - [List Voice Dictionaries](https://docs.tryhamsa.com/api-reference/endpoint/list-voice-dictionaries.md): Retrieves a paginated list of voice dictionaries. - [Get Voice Dictionary by ID](https://docs.tryhamsa.com/api-reference/endpoint/get-voice-dictionary.md): Retrieves a specific voice dictionary by its unique identifier. - [Update Voice Dictionary](https://docs.tryhamsa.com/api-reference/endpoint/update-voice-dictionary.md): Updates an existing voice dictionary. - [Toggle Voice Dictionary Activation](https://docs.tryhamsa.com/api-reference/endpoint/toggle-voice-dictionary-activation.md): Activates or deactivates a voice dictionary for a specific voice agent. - [Create new knowledge base items.](https://docs.tryhamsa.com/api-reference/create-new-knowledge-base-items.md) - [Update a knowledge base item by Id.](https://docs.tryhamsa.com/api-reference/update-a-knowledge-base-item-by-id.md) - [Delete Knowledge Base Item](https://docs.tryhamsa.com/api-reference/endpoint/delete-kb-item.md): Deletes a knowledge base item. Returns an error if the item is currently active in a voice agent. - [Get Knowledge Base Item by ID](https://docs.tryhamsa.com/api-reference/endpoint/get-kb-item.md): Retrieves detailed information about a specific knowledge base item. - [Return a list of Knowledge Base Items.](https://docs.tryhamsa.com/api-reference/return-a-list-of-knowledge-base-items.md) - [Toggle activation of a knowledge base item for a voice agent.](https://docs.tryhamsa.com/api-reference/toggle-activation-of-a-knowledge-base-item-for-a-voice-agent.md) - [Get Knowledge Base Size Info](https://docs.tryhamsa.com/api-reference/endpoint/get-kb-size-info.md): Retrieves the total size of all knowledge base items and the size limit based on the subscription plan. - [Add URL to Knowledge Base Item](https://docs.tryhamsa.com/api-reference/endpoint/add-url-to-kb-item.md): Adds a new URL to an existing knowledge base URL item for processing. - [Delete URL from Knowledge Base Item](https://docs.tryhamsa.com/api-reference/endpoint/delete-url-from-kb-item.md): Removes a specific URL from an existing knowledge base URL item. - [List Collections](https://docs.tryhamsa.com/api-reference/endpoint/list-collections.md): Retrieves a paginated list of collections with optional search functionality. - [Create Collection](https://docs.tryhamsa.com/api-reference/endpoint/create-collection.md): Creates a new collection for organizing web tools. - [Update Collection](https://docs.tryhamsa.com/api-reference/endpoint/update-collection.md): Updates an existing collection's name or description. - [Delete Collection](https://docs.tryhamsa.com/api-reference/endpoint/delete-collection.md): Deletes an existing collection. Web tools in the collection will be moved outside the collection. - [Move Web Tool to Collection](https://docs.tryhamsa.com/api-reference/endpoint/move-tool-to-collection.md): Moves a web tool into a collection or removes it from a collection (when collectionId is null). - [Get a web tool by ID.](https://docs.tryhamsa.com/api-reference/get-a-web-tool-by-id.md) - [Delete a web tool by Id.](https://docs.tryhamsa.com/api-reference/delete-a-web-tool-by-id.md) - [Toggle activation of a web tool for a voice agent.](https://docs.tryhamsa.com/api-reference/toggle-activation-of-a-web-tool-for-a-voice-agent.md) - [Test API Tool Configuration](https://docs.tryhamsa.com/api-reference/endpoint/test-api-tool.md): Validates API connectivity with retry logic and streams real-time test results via Server-Sent Events. - [Create Web Tool](https://docs.tryhamsa.com/api-reference/endpoint/v2/create-web-tool.md): Creates a new web tool for a project. Web tools can be of type FUNCTION, MCP, or WEB_TOOL. - [List Web Tools](https://docs.tryhamsa.com/api-reference/endpoint/v2/list-web-tools.md): Retrieves a paginated list of web tools with optional filtering by project, status, type, collection, and search term. - [Update Web Tool](https://docs.tryhamsa.com/api-reference/endpoint/v2/update-web-tool.md): Updates an existing web tool by ID. All fields are optional except projectId. - [Check Newer Versions](https://docs.tryhamsa.com/api-reference/endpoint/v2/version-check-web-tools.md): Checks if newer versions are available for the specified web tools. Can also detect conflicts with user overrides. - [Create Secret](https://docs.tryhamsa.com/api-reference/endpoint/create-secret.md): Creates a new secret for the specified project. Secrets are encrypted and stored securely. - [List Secrets](https://docs.tryhamsa.com/api-reference/endpoint/list-secrets.md): Retrieves a paginated list of secrets for the specified project. Secret values are not included in the response. - [Update Secret](https://docs.tryhamsa.com/api-reference/endpoint/update-secret.md): Updates an existing secret. You can update the name, value, description, or tags. - [Delete Secret](https://docs.tryhamsa.com/api-reference/endpoint/delete-secret.md): Permanently deletes a secret from the project. - [Create AI Content Route](https://docs.tryhamsa.com/api-reference/endpoint/post-ai-content.md) - [Get AI Content Route](https://docs.tryhamsa.com/api-reference/endpoint/get-ai-content.md) - [Create Customized AI Content Route](https://docs.tryhamsa.com/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://docs.tryhamsa.com/api-reference/endpoint/ai-content-estimate.md): Returns the estimated cost for the specified AI content job. - [Generate AI Content](https://docs.tryhamsa.com/api-reference/endpoint/generate-transcription-ai-content-v2.md): Submit a transcription job that also generates AI content based on provided parts. - [Get Jobs List](https://docs.tryhamsa.com/api-reference/endpoint/get-jobs-list.md) - [Get Job Details By Id](https://docs.tryhamsa.com/api-reference/endpoint/get-job-by-id.md) - [List Jobs](https://docs.tryhamsa.com/api-reference/endpoint/list-jobs-v2.md): Retrieve a paginated list of jobs with optional filtering and sorting. - [Get Single Job](https://docs.tryhamsa.com/api-reference/endpoint/get-job-v2.md): Retrieve detailed information about a specific job. - [Update Job Title](https://docs.tryhamsa.com/api-reference/endpoint/update-job-title-v2.md): Update the title of a job. - [Delete Job](https://docs.tryhamsa.com/api-reference/endpoint/delete-job-v2.md): Delete a job by its unique identifier. - [Get Project By API Key](https://docs.tryhamsa.com/api-reference/endpoint/get-project-by-api-key.md) - [Get Usage Statistics Numbers](https://docs.tryhamsa.com/api-reference/endpoint/statistics-numbers.md) - [Get Usage Statistics Chart](https://docs.tryhamsa.com/api-reference/endpoint/statistics-chart.md) - [Get Overview Analytics](https://docs.tryhamsa.com/api-reference/endpoint/get-overview-analytics.md): Retrieves overview analytics for voice agents including live sessions, total sessions, average session duration, and calls over time. - [Get Performance Analytics](https://docs.tryhamsa.com/api-reference/endpoint/get-performance-analytics.md): Retrieves performance analytics for voice agents including ASR processing time, LLM response time, TTS generation time, latency, and error rates. - [Get Satisfaction and Outcome Analytics](https://docs.tryhamsa.com/api-reference/endpoint/get-satisfaction-analytics.md): Retrieves satisfaction and outcome analytics for voice agents including NPS score, sentiment distribution, CSAT score, first call resolution, and escalation rate. - [Export Conversations](https://docs.tryhamsa.com/api-reference/endpoint/export-conversations.md): Exports conversation data for a voice agent as an Excel file. Returns the file as a downloadable attachment. - [Get Call Log by ID](https://docs.tryhamsa.com/api-reference/endpoint/get-call-log.md): Retrieves a single call log record by its unique identifier. - [List Call Logs](https://docs.tryhamsa.com/api-reference/endpoint/list-call-logs.md): Retrieves a list of call logs for a specific job. - [Create Voice Agent Route](https://docs.tryhamsa.com/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. - [Update Voice Agent Route](https://docs.tryhamsa.com/api-reference/endpoint/update-voice-agent.md) - [Get Voice Agents List Route](https://docs.tryhamsa.com/api-reference/endpoint/get-all-voice-agents.md) - [Get A Voice Agent By Id Route](https://docs.tryhamsa.com/api-reference/endpoint/get-voice-agent-by-id.md) - [Start a Call for a Conversation Route](https://docs.tryhamsa.com/api-reference/endpoint/start-a-call.md) - [Create a new web tool.](https://docs.tryhamsa.com/api-reference/create-a-new-web-tool.md) - [Update a web tool by Id.](https://docs.tryhamsa.com/api-reference/update-a-web-tool-by-id.md) - [Return a list of Web Tools.](https://docs.tryhamsa.com/api-reference/return-a-list-of-web-tools.md) - [Check Web Tool Version Updates](https://docs.tryhamsa.com/api-reference/endpoint/version-check.md): Checks if there are newer versions available for the specified web tools. - [Real-Time WebSocket API](https://docs.tryhamsa.com/websocket/websocket-api.md): Connect to Hamsa's real-time WebSocket API for streaming Text-to-Speech and Speech-to-Text - [Text-to-Speech](https://docs.tryhamsa.com/websocket/websocket-tts.md): Convert text to streaming audio via WebSocket - [Speech-to-Text](https://docs.tryhamsa.com/websocket/websocket-stt.md): Transcribe audio to text via WebSocket - [Changelog](https://docs.tryhamsa.com/changelog/main.md): What is new in Hamsa ## OpenAPI Specs - [openapi](https://docs.tryhamsa.com/api-reference/openapi.json) ## AsyncAPI Specs - [asyncapi-tts](https://docs.tryhamsa.com/websocket/asyncapi-tts.json) - [asyncapi-stt](https://docs.tryhamsa.com/websocket/asyncapi-stt.json)