v1

latestOpenAPI 3.0.1MIT2026-07-26104203277.0 KB

Retrieve a list of voice agents

get/v1/voice-agents

Query parameters

skipinteger

takeinteger

searchstring

Example:Test Agent

A search query to search agents by name

sortField'createdAt'

Example:createdAt

Optional sort field

sortOrder'asc' | 'desc'

Example:desc

Optional sort order

typestring[]

Multi-select filter on the type of the voice agents to return

[
  "Single Prompt",
  "Flow Agent"
]

languagestring[]

Multi-select filter on the language of the voice agents to return

[
  "ar",
  "en"
]

Response

Successful response

successboolean

messagestring

Example response

{
  "data": {
    "voiceAgents": [
      {
        "outcomeResponseShape": {
          "type": "object",
          "properties": {
            "test": {
              "type": "number",
              "description": "Hello world from Hamsa AI!"
            }
          },
          "required": [
            "test"
          ]
        },
        "webhookUrl": "https://example.com/webhook",
        "webhookAuth": {
          "authKey": "Token",
          "authSecret": "Secret"
        },
        "llmConfig": {
          "provider": "OpenAI",
          "modelName": "GPT-4.1",
          "baseUrl": "https://api.custom-llm.com/v1",
          "apiKey": "sk-...",
          "temperature": 0.2
        }
      }
    ]
  }
}