/
TR
tryhamsa
/
Hamsa API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 2w ago · Updated 2w ago
View markdown
tryhamsa
Hamsa API
get
Get a project by API key
v1
latest
OpenAPI 3.0.1
MIT
2026-07-26
104
203
277.0 KB
Conversations
2
post
Create a new web tool.
post
Create new knowledge base items.
get
List TTS histories
post
Create TTS history
get
List TTS voices
post
Create TTS voice
get
Get a web tool by ID.
delete
Delete a web tool by Id.
patch
Update a web tool by Id.
get
Get TTS history
delete
Delete TTS history
get
Get TTS voice
delete
Delete TTS voice
get
Get a phone number by its ID.
post
Add a phone number for a user.
delete
Delete a Phone Number
post
Add URL to Knowledge Base URL Item.
delete
Delete URL from Knowledge Base URL Item.
get
Estimate AI Content Cost
post
Assign a phone number to a Voice Agent.
post
Call Voice Agent using Twilio custom phone number.
post
Cancel a campaign
post
Clone a voice agent
get
List campaigns with pagination
post
Create an outbound campaign
post
Create Collection.
get
List Jobs
post
Create Job
post
Create a Secret
get
Retrieve a list of voice agents
post
Create a new voice agent
get
List Voice Agents
post
Create Voice Agent
post
Create a Voice Dictionary
post
Generate Customized AI Content
get
Get a campaign by ID
delete
Delete a campaign
patch
Update a campaign's name
delete
Delete Collection.
patch
Update Collection.
delete
Delete Job
patch
Update Job Title
get
Get Knowledge Base Item by ID.
delete
Delete Knowledge Base Item.
patch
Update a knowledge base item by Id.
delete
Delete a Secret
patch
Update a Secret
get
Export Conversations
post
Generate AI Content
post
Initiate a text to speech job
get
Get AI-generated content
post
Create AI Content
get
Get Call Log by ID
get
Get Conversation by ID.
get
Retrieve job details
get
Get Single Job
post
Get a list of jobs
get
Get Knowledge Base Size Information.
get
Get Overview Analytics
get
Get Performance Analytics
get
Get a project by API key
get
Get Satisfaction and Outcome Analytics
get
Retrieve a specific voice agent by ID
patch
Update an existing voice agent
get
Get Voice Agent
patch
Update Voice Agent
get
Get Voice Dictionary by ID
patch
Update Voice Dictionary
get
List Call Logs
get
List Collections.
get
Return a list of phone numbers for a user.
get
List Secrets
get
List Voice Dictionaries
post
Move Web Tool to Collection.
post
Pause a campaign
post
Preload a cloned TTS voice into the system
post
Resume a paused campaign
post
Retry a campaign
post
Generates an speech to text transcription (not streamed).
post
Generates an audio file from a text string (not streamed).
post
Generates a streamed audio file from a text string.
post
Initiate a call with a voice agent. This endpoint is kept to testing outbound calls via Twilio only.
get
Get project statistics chart data
get
Get project statistics with numbers
post
Test API Tool connectivity and validate configuration.
post
Toggle Voice Dictionary Activation
post
Transcribe media to text
post
Unassign a phone number from Voice Agents.
post
Create Web Tool
get
List Web Tools
patch
Update Web Tool
post
Check Newer Versions for Web Tools
post
Check for newer versions of Web Tools.
post
Extract transcription from voice audio
post
Favorite a TTS voice
get
Get default TTS voice
get
List dialects
post
Preview TTS voice
get
Return a list of Knowledge Base Items.
get
Return a list of Web Tools.
post
Toggle activation of a knowledge base item for a voice agent.
Get a project by API key
get
/v1/projects/by-api-key
Response
Successful response
ProjectResponse
required
success
boolean
message
string
data
Project