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

# Get pronunciation status API

> Check whether a Bolna voice agent's pronunciation word lists are applied to calls: active, pending or failed.

After you save an agent with a pronunciation word list, the list takes a few seconds to be applied to calls. Call this endpoint to know when it's ready, for example before placing a test call.

| `status` | Meaning |
| - | - |
| `active` | Every word list is applied to calls. |
| `pending` | Being applied. This usually takes a few seconds after a save. |
| `failed` | Couldn't be applied. Save the agent again. |
| `null` | The agent has no word list on a voice that supports one. |

See [Pronunciation](https://www.bolna.ai/docs/customizations/pronunciation.md) for how to set word lists.


## OpenAPI

````yaml GET /v2/agent/{agent_id}/pronunciation-dictionary-status
openapi: 3.1.0
info:
  title: Bolna API
  description: >-
    Use and leverage Bolna Voice AI using APIs through HTTP requests from any
    language in your applications and workflows.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.bolna.ai
    description: Production server
security:
  - bearerAuth: []
tags:
  - name: SIP trunks
    description: >-
      Bring-your-own-carrier SIP trunks, their gateways, carrier IPs and
      numbers.
paths:
  /v2/agent/{agent_id}/pronunciation-dictionary-status:
    get:
      description: >-
        Check whether an agent's pronunciation word lists are applied to calls.
        After you save a list it is `pending` for a few seconds, then `active`.
      parameters:
        - in: path
          name: agent_id
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Pronunciation status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PronunciationDictionaryStatus'
              example:
                status: active
        '404':
          description: Agent not found
          content:
            application/json:
              example:
                message: Invalid Agent ID.
components:
  schemas:
    PronunciationDictionaryStatus:
      type: object
      properties:
        status:
          type: string
          nullable: true
          enum:
            - active
            - pending
            - failed
          description: >-
            `active`: every word list is applied to calls. `pending`: being
            applied, usually for a few seconds after a save. `failed`: couldn't
            be applied; save the agent again. `null`: the agent has no word list
            on a voice that supports one.
          example: active
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

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