Skip to main content
GET
/
v1
/
voice-agents
/
voice-dictionaries
/
{id}
Get Voice Dictionary by ID
curl --request GET \
  --url https://api.tryhamsa.com/v1/voice-agents/voice-dictionaries/{id} \
  --header 'Authorization: <api-key>'
{
  "success": true,
  "data": {
    "id": "48f7656f-098b-4c43-b165-7cfd2cc8ac30",
    "name": "Medical Terms Dictionary",
    "words": [
      {
        "word": "acetaminophen",
        "pronunciation": "uh-SEE-tuh-MIN-uh-fen"
      }
    ],
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:30:00Z"
  }
}

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 '

Path Parameters

​
id
string<uuid>
required

UUID of the voice dictionary.

Example:

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

Response

Successful response

​
success
boolean
Example:

true

​
data
object