DocumentationAPI Reference
DocumentationAPI Reference
Book a meeting
Linkedin
Github
  1. Agents
  • Agents
    • List all agents
      GET
    • Create a new agent
      POST
    • Get an agent
      GET
    • Update an agent
      PATCH
    • Delete an agent
      DELETE
  • Tool Templates
    • List all tool templates
      GET
    • Create a new tool template
      POST
    • Get a tool template
      GET
    • Update a tool template
      PATCH
    • Delete a tool template
      DELETE
  • Numbers
    • List all phone numbers
      GET
    • Register a phone number
      POST
    • Get a phone number
      GET
    • Update a phone number
      PATCH
    • Delete a phone number
      DELETE
  • Calls
    • List calls
      GET
    • Get call by ID
      GET
    • Initiate outbound call
      POST
  • Call Control
    • Send control command to active call
      POST
  • Usage
    • Get usage logs
      GET
  • SIP Trunks
    • List SIP trunks
      GET
    • Create a SIP trunk
      POST
    • Get a SIP trunk
      GET
    • Delete a SIP trunk
      DELETE
  • Voices
    • List available voices
  • BYOK
    • Get BYOK configurations
    • Add BYOK configuration
    • Delete BYOK configuration
    • Get BYOK provider configurations
  • Domains
    • Get your domain
    • Add a domain
    • Delete your domain
    • List available Resend domains
    • Select and sync a Resend domain
    • Verify domain DNS records
    • Refresh domain status
  • Webhooks
    • Dynamic assistant configuration webhook
    • Tool/Function Call
    • Call Status Update
    • End of Call Report
  • Analysis Templates
    • List analysis templates
    • Create analysis template
    • Get analysis template
    • Update analysis template
    • Delete analysis template
  • Organization
    • Get organization information
    • Create organization
    • Get organization information (deprecated)
  • Campaigns
    • List all campaigns
    • Create a campaign
    • Get a campaign
    • Update a campaign
    • Delete a campaign
    • List campaign leads
    • Add a lead
    • Remove a lead
  • Schemas
    • Error
    • Pagination
    • UUID
    • Timestamp
    • SuccessResponse
    • STTConfig
    • LLMConfig
    • TTSConfig
    • XAIRealtimeConfig
    • Agent
    • AgentCreate
    • AgentUpdate
    • PhoneNumber
    • PhoneNumberCreate
    • PhoneNumberUpdate
    • Call
    • CallControlCommand
    • InjectContextCommand
    • SayCommand
    • EndCallCommand
    • TransferCommand
    • CallControlResponse
    • OutboundCallRequest
    • Account
    • UsageLog
    • OutboundCallResponse
    • UsageSummary
    • Organization
    • SipTrunk
    • SipTrunkCreate
    • OrganizationChild
    • Voice
    • OrganizationCreate
    • OrganizationCreated
    • AssistantRequestPayload
    • CallObject
    • Customer
    • AssistantRequestResponse
    • XAIRealtimeVoice
    • AssistantConfigOverride
    • AnalysisPlan
    • AssistantWebhookObject
    • ToolCallsPayload
    • ToolCall
    • ToolCallsResponse
    • StatusUpdatePayload
    • EndOfCallReportPayload
    • ToolDefinition
    • EndCallTool
    • TransferCallTool
    • WebhookHeaders
    • XAIRealtimeWebhookNotes
    • ToolFunctionConfig
    • ToolTransferConfig
    • ToolTemplate
    • ToolTemplateCreate
    • ToolTemplateUpdate
    • AnalysisTemplate
    • CreateAnalysisTemplate
    • UpdateAnalysisTemplate
    • AnalysisTemplateListResponse
    • CampaignLead
    • Campaign
    • CampaignCreate
    • CampaignUpdate
    • CampaignLeadCreate
DocumentationAPI Reference
DocumentationAPI Reference
Book a meeting
Linkedin
Github
  1. Agents

List all agents

GET
https://api.hmsovereign.com/api/v1/agents
Agents
Last modified:2026-01-30 13:43:45
Maintainer:Jesper Rietbergen
Retrieve all AI voice agents in your organization.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************

Responses

🟢200
application/json
List of agents
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.hmsovereign.com/api/v1/agents' \
--header 'Authorization: Bearer <token>'
Response Response Example
{
    "agents": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "Customer Support Agent",
            "business_name": "Acme Corp",
            "notification_email": "support@acme.com",
            "first_message": "Hello, welcome to Acme. How can I help you today?",
            "is_active": true,
            "max_duration_seconds": 300,
            "autonomous_silence_handling": false,
            "voicemail_detection": false,
            "voicemail_message": "Hello, this is Acme Corp. We will call you back at a later time. Thank you!",
            "webhook_url": "http://example.com",
            "webhook_secret": "string",
            "webhook_events": [
                "string"
            ],
            "analysis_plan": {
                "structured_data_plan": {
                    "enabled": true,
                    "schema": {
                        "type": "object",
                        "properties": {
                            "intent": {
                                "type": "string"
                            },
                            "sentiment": {
                                "type": "string",
                                "enum": [
                                    "positive",
                                    "neutral",
                                    "negative"
                                ]
                            },
                            "appointment_booked": {
                                "type": "boolean"
                            }
                        }
                    },
                    "messages": [
                        {
                            "role": "system",
                            "content": "Analyze the following call transcript according to this schema: {{schema}}"
                        }
                    ]
                },
                "min_messages_threshold": 2
            },
            "stt_config": {
                "provider": "deepgram",
                "model": "nova-3-general",
                "language": "multi",
                "keyterms": [
                    "yes",
                    "no",
                    "okay",
                    "Acme"
                ]
            },
            "llm_config": {
                "provider": "openai",
                "model": "gpt-5",
                "voice": "ara",
                "temperature": 0.7,
                "messages": [
                    {
                        "role": "system",
                        "content": "string"
                    }
                ],
                "tools": [
                    {}
                ]
            },
            "tts_config": {
                "provider": "openai",
                "voice_id": "alloy",
                "model": "eleven_flash_v2_5",
                "language": "nl",
                "stability": 0.5,
                "similarity_boost": 0.75,
                "use_speaker_boost": true,
                "speed": 1,
                "style": 0
            },
            "created_at": "2019-08-24T14:15:22.123Z",
            "updated_at": "2019-08-24T14:15:22.123Z"
        }
    ]
}
Modified at 2026-01-30 13:43:45
Next
Create a new agent
Built with