> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tryhamsa.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Save Pronunciation Check

> Sets the verdict for one word and voice, after listening to it. Returns that word's verdict for the voice.



## OpenAPI

````yaml /api-reference/openapi.json put /v1/voice-agents/voice-dictionaries/{id}/validations
openapi: 3.0.1
info:
  title: Hamsa API
  description: >-
    The Hamsa API: voice agents and their calls, phone numbers, batch calls and
    knowledge bases; speech to text, text to speech, voices and AI content.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.tryhamsa.com
security: []
paths:
  /v1/voice-agents/voice-dictionaries/{id}/validations:
    put:
      summary: Save a pronunciation check
      description: >-
        Sets the verdict for one word and voice, after listening to it. Returns
        that word's verdict for the voice.
      parameters:
        - in: path
          name: id
          required: true
          description: ID of the voice dictionary.
          schema:
            type: string
            format: uuid
            example: 48f7656f-098b-4c43-b165-7cfd2cc8ac30
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - word
                - voiceId
                - status
              properties:
                word:
                  type: string
                  minLength: 1
                  description: A word from the dictionary's `entries`.
                  example: API
                voiceId:
                  type: string
                  minLength: 1
                  description: The TTS voice you listened with.
                  example: 078338c4-7788-4371-95d4-1bbe45021113
                status:
                  type: string
                  enum:
                    - untested
                    - attempted
                    - passed
                    - failed
                  description: >-
                    `untested`: not listened to yet (also set again when the
                    word's pronunciation changes). `attempted`: listened to, no
                    verdict. `passed`: sounds right. `failed`: sounds wrong.
                  example: passed
            examples:
              passed:
                summary: Sounds right
                value:
                  word: API
                  voiceId: 078338c4-7788-4371-95d4-1bbe45021113
                  status: passed
              failed:
                summary: Sounds wrong
                value:
                  word: API
                  voiceId: 078338c4-7788-4371-95d4-1bbe45021113
                  status: failed
              attempted:
                summary: Listened, no verdict
                value:
                  word: API
                  voiceId: 078338c4-7788-4371-95d4-1bbe45021113
                  status: attempted
              untested:
                summary: Reset
                value:
                  word: API
                  voiceId: 078338c4-7788-4371-95d4-1bbe45021113
                  status: untested
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Voice dictionary validation saved successfully
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/DictionaryPronounceValidation'
                    description: The saved verdict.
        '400':
          description: >-
            Invalid body, or the word is not in the dictionary
            (`WordNotInDictionary`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
        '401':
          description: 'Unauthorized: missing or invalid API key.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
        '404':
          description: Dictionary not found in your project (`DictionaryDoesNotExist`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
        '500':
          description: Server Side Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    DictionaryPronounceValidation:
      type: object
      properties:
        word:
          type: string
          description: The dictionary word.
          example: API
        voiceId:
          type: string
          description: The TTS voice the verdict is for.
          example: 078338c4-7788-4371-95d4-1bbe45021113
        status:
          type: string
          enum:
            - untested
            - attempted
            - passed
            - failed
          description: >-
            `untested`: not listened to yet (also set again when the word's
            pronunciation changes). `attempted`: listened to, no verdict.
            `passed`: sounds right. `failed`: sounds wrong.
          example: passed
        updatedBy:
          type: string
          nullable: true
          description: ID of the user who set the status.
          example: b7d9e979-4a16-437b-8571-4ed92a94faa8
        updatedAt:
          type: string
          format: date-time
          example: '2026-11-02T09:15:00.000Z'
    ErrorSchema:
      type: object
      properties:
        code:
          type: integer
          description: >-
            Service error code: the HTTP status with a service prefix (for
            example `8404`). Missing when the service has no code for that
            status.
          example: 8404
        message:
          type: string
          description: >-
            What went wrong. Some services (calls and recordings) put the error
            key here, for example `CallNotFoundOrUnavailable`, and send no
            `messageKey`.
          example: Policy not found!
        messageKey:
          type: string
          description: >-
            Stable key for the error, safe to match on in code. Not returned by
            every service.
          example: PolicyNotFound
        params:
          type: object
          additionalProperties: true
          description: >-
            Details for some errors (for example `reason`). Not returned by
            every service.
          example:
            reason: NO_DRAFT
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Pass the API key in the Authorization header, You need to put Token
        keyword before the API key. e.g. 'Authorization: Token <api-key>'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.