List Voice Agents

Changed on Nov 3, 2026

Retrieves a paginated list of voice agents with filtering and sorting options.

get/v2/voice-agents

Request

Base URL
https://api.tryhamsa.com
URL
https://api.tryhamsa.com/v2/voice-agents
Auth
API key in header Authorization

Query parameters

skipinteger

Example:1

Page number (pagination).

takeinteger

Example:10

Number of items to take per page (pagination).

searchstring

Example:Test Agent

Search query to filter agents by name.

sortField'createdAt'

Example:createdAt

Field to sort by.

sortOrder'asc' | 'desc'

Example:desc

Sort order.

typestring[]

Multi-select filter on the type of voice agents.

[
  "Single Prompt",
  "Flow Agent"
]

languagestring[]

Multi-select filter on the language of voice agents.

[
  "ar",
  "en"
]

Response

Successful response

successboolean

Example response

{
  "success": true,
  "data": {
    "total": 25,
    "filtered": 10,
    "voiceAgents": [
      {
        "id": "48f7656f-098b-4c43-b165-7cfd2cc8ac30",
        "type": "Single Prompt",
        "name": "Customer Support Agent",
        "conversation": {
          "greetingMessage": "Hello, how can I help you today?",
          "preamble": "You are a helpful assistant.",
          "pokeMessages": [],
          "params": {},
          "alignment": {
            "greetingMessage": "ltr",
            "preamble": "ltr"
          }
        },
        "voice": {
          "voiceId": "en-US-Neural2-A",
          "lang": "en"
        },
        "llm": {
          "provider": "openai",
          "model": "gpt-4",
          "temperature": 0.2
        },
        "callSettings": {
          "noiseCancellation": "telephony_optimized",
          "cancelNoisePer": "conversation",
          "interrupt": true,
          "responseDelay": 400,
          "userInactivityTimeout": 15,
          "maxCallDuration": 300,
          "silenceThreshold": 800,
          "minInterruptionDuration": 0.5,
          "vadActivationThreshold": 0.5
        },
        "knowledgeBaseItemsIds": [],
        "voiceDictionaryIds": [],
        "phoneNumber": {
          "type": "TWILIO",
          "id": "48f7656f-098b-4c43-b165-7cfd2cc8ac30"
        },
        "workflow": {
          "nodes": [
            {
              "id": "2ZHj3IUpJFc-83H2-f8d3",
              "type": "start",
              "label": "Start",
              "message": "Hello, how can I help you today?",
              "messageType": "prompt",
              "position": {
                "x": 0,
                "y": 0
              },
              "metadata": {
                "version": 1
              },
              "transitions": []
            }
          ],
          "edges": [],
          "customVariables": [
            {
              "id": "z5QsyxUbrKPjYMGaMj1e1",
              "name": "customer_name",
              "dataType": "string",
              "description": "",
              "defaultValue": "john",
              "extractionPrompt": "",
              "enumValues": []
            }
          ]
        },
        "createdAt": "2024-01-15T10:30:00Z",
        "updatedAt": "2024-01-15T10:30:00Z",
        "account": {
          "plan": "pro"
        }
      }
    ]
  }
}

Changes

Nov 3, 20267e6123597b29 Revision changes
- info
  added conversation start tool web_tool transfer_call end_call transfer_agent router set_local_variables change_agent_settings discriminator mapping keys to the ///////// response property for the response status
- info
  added natural_language structured_equation dtmf always auto discriminator mapping keys to the //////////////////// response property for the response status
- info
  added natural_language structured_equation dtmf always auto discriminator mapping keys to the //////////////////// response property for the response status
- info
  added natural_language structured_equation dtmf always auto discriminator mapping keys to the //////////////////// response property for the response status
- info
  added natural_language structured_equation dtmf always auto discriminator mapping keys to the //////////////////// response property for the response status
- info
  added natural_language structured_equation dtmf always auto discriminator mapping keys to the //////////////////// response property for the response status
- info
  added natural_language structured_equation dtmf always auto discriminator mapping keys to the //////////////////// response property for the response status
- info
  added natural_language structured_equation dtmf always auto discriminator mapping keys to the //////////////////// response property for the response status
- info
  added natural_language structured_equation dtmf always auto discriminator mapping keys to the //////////////////// response property for the response status
- info
  added natural_language structured_equation dtmf always auto discriminator mapping keys to the //////////////////// response property for the response status
- info
  added natural_language structured_equation dtmf always auto discriminator mapping keys to the //////////////////// response property for the response status

Operation history