Skip to main content
GET
/
v1
/
voice-agents
Retrieve a list of voice agents
curl --request GET \
  --url https://api.tryhamsa.com/v1/voice-agents \
  --header 'Authorization: <api-key>'
{
  "success": false,
  "message": "success",
  "data": {
    "total": 123,
    "filtered": 123,
    "voiceAgents": [
      {
        "id": "<string>",
        "agentName": "<string>",
        "greetingMessage": "<string>",
        "description": "<string>",
        "preamble": "<string>",
        "lang": "<string>",
        "pokeMessages": [
          "<string>"
        ],
        "realTime": true,
        "silenceThreshold": 123,
        "interrupt": true,
        "outcome": "<string>",
        "outcomeResponseShape": {
          "type": "object",
          "properties": {
            "test": {
              "type": "number",
              "description": "Hello world from Hamsa AI!"
            }
          },
          "required": [
            "test"
          ]
        },
        "projectId": "<string>",
        "apiKeyId": "<string>",
        "voiceRecordId": "<string>",
        "voiceRecord": {},
        "webhookUrl": "https://example.com/webhook",
        "webhookAuth": {
          "authKey": "Token",
          "authSecret": "Secret"
        },
        "params": {},
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Pass the API key in the Authorization header, You need to put Token keyword before the API key. e.g. 'Authorization: Token <api-key>'

Query Parameters

skip
integer
default:1
take
integer
default:10

Response

Successful response

success
boolean
default:false
message
string
default:success
data
object