Skip to main content
GET
/
v1
/
voice-agents
/
templates
Retrieve a specific voice agent by ID
curl --request GET \
  --url https://api.tryhamsa.com/v1/voice-agents/templates \
  --header 'Authorization: <api-key>'
{
  "success": false,
  "message": "success",
  "data": [
    {
      "id": "<string>",
      "agentName": "<string>",
      "greetingMessage": "<string>",
      "description": "<string>",
      "preamble": "<string>",
      "lang": "<string>",
      "voice": "ar-msa",
      "pokeMessages": [
        "<string>"
      ],
      "realTime": true,
      "silenceThreshold": 123,
      "interrupt": true,
      "outcome": "<string>",
      "isTemplate": true,
      "icon": "<string>",
      "projectId": "<string>",
      "apiKeyId": "<string>",
      "voiceRecordId": "<string>",
      "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 '

Response

Successful response

​
success
boolean
default:false
​
message
string
default:success
​
data
object[]