Skip to main content
GET
/
v1
/
voice-agents
/
voice-dictionaries
/
list
List Voice Dictionaries
curl --request GET \
  --url https://api.tryhamsa.com/v1/voice-agents/voice-dictionaries/list \
  --header 'Authorization: <api-key>'
{
  "success": true,
  "data": {
    "dictionaries": [
      {
        "id": "48f7656f-098b-4c43-b165-7cfd2cc8ac30",
        "name": "Medical Terms Dictionary",
        "wordsCount": 25,
        "isUsed": true,
        "createdAt": "2024-01-15T10:30:00Z"
      }
    ],
    "total": 100,
    "page": 1,
    "pageSize": 10
  }
}

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 '

Query Parameters

​
skip
integer
default:1

Number of items to skip (pagination).

Example:

1

​
take
integer
default:10

Number of items to take (pagination).

Example:

10

​
search
string

Optional search text, applied to dictionary names.

Example:

"Medical"

​
used
boolean

Filter by whether the dictionary is actively used by a voice agent.

Example:

true

​
voiceAgentId
string<uuid>

Filter by voice agent ID.

Example:

"48f7656f-098b-4c43-b165-7cfd2cc8ac30"

Response

Successful response

​
success
boolean
Example:

true

​
data
object