API Evangelist conversational phrasing for ElevenLabs API Documentation Pronunciation Dictionary API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for ElevenLabs API Documentation Pronunciation Dictionary API
  version: 1.0.0
extends: openapi/elevenlabs-pronunciation-dictionary-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/v1/pronunciation-dictionaries/add-from-file'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a pronunciation dictionary from a PLS file
      effect: write
      questions:
      - Can I import an existing PLS lexicon as a pronunciation dictionary?
      - How do I upload a lexicon file so brand names are pronounced correctly?
      instructions:
      - text: Create a pronunciation dictionary named {name} from PLS file {file}.
        slots:
          name: requestBody.name
          file: requestBody.file
      - text: Import lexicon {file} as dictionary {name} with workspace access {workspace_access}.
        slots:
          file: requestBody.file
          name: requestBody.name
          workspace_access: requestBody.workspace_access
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/pronunciation-dictionaries/add-from-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a pronunciation dictionary from rules
      effect: write
      questions:
      - Can I build a pronunciation dictionary by listing rules instead of uploading a file?
      - What's needed to start a dictionary with alias or phoneme rules?
      instructions:
      - text: Create a pronunciation dictionary {name} with rules {rules}.
        slots:
          name: requestBody.name
          rules: requestBody.rules
      - text: Start a new dictionary called {name} described as {description} from rules {rules}.
        slots:
          name: requestBody.name
          description: requestBody.description
          rules: requestBody.rules
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/pronunciation-dictionaries/{pronunciation_dictionary_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pronunciation dictionary's metadata
      effect: read
      questions:
      - What is the latest version of a pronunciation dictionary?
      - Can I look up one dictionary's details by ID?
      instructions:
      - text: Get metadata for pronunciation dictionary {pronunciation_dictionary_id}.
        slots:
          pronunciation_dictionary_id: path.pronunciation_dictionary_id
      - text: Show the details of dictionary {pronunciation_dictionary_id}.
        slots:
          pronunciation_dictionary_id: path.pronunciation_dictionary_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/pronunciation-dictionaries/{pronunciation_dictionary_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or archive a pronunciation dictionary
      effect: write
      questions:
      - Can I archive a pronunciation dictionary I no longer use?
      - Does renaming a dictionary create a new version?
      instructions:
      - text: Rename pronunciation dictionary {pronunciation_dictionary_id} to {name}.
        slots:
          pronunciation_dictionary_id: path.pronunciation_dictionary_id
          name: requestBody.name
      - text: Set archived to {archived} on dictionary {pronunciation_dictionary_id}.
        slots:
          archived: requestBody.archived
          pronunciation_dictionary_id: path.pronunciation_dictionary_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/pronunciation-dictionaries/{pronunciation_dictionary_id}/set-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Replace all rules in a pronunciation dictionary
      effect: write
      questions:
      - How do I overwrite every rule in a dictionary with a new set?
      - Is there a way to reset a pronunciation dictionary's rules completely?
      instructions:
      - text: Replace all rules in dictionary {pronunciation_dictionary_id} with {rules}.
        slots:
          pronunciation_dictionary_id: path.pronunciation_dictionary_id
          rules: requestBody.rules
      - text: Overwrite the rule set of {pronunciation_dictionary_id} with {rules}.
        slots:
          pronunciation_dictionary_id: path.pronunciation_dictionary_id
          rules: requestBody.rules
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/pronunciation-dictionaries/{pronunciation_dictionary_id}/add-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Add rules to a pronunciation dictionary
      effect: write
      questions:
      - Can I add a few new pronunciations to an existing dictionary?
      - What happens if I add a rule for a word that's already in the dictionary?
      instructions:
      - text: Add rules {rules} to dictionary {pronunciation_dictionary_id}.
        slots:
          rules: requestBody.rules
          pronunciation_dictionary_id: path.pronunciation_dictionary_id
      - text: Append pronunciation rules {rules} to {pronunciation_dictionary_id}, replacing matches.
        slots:
          rules: requestBody.rules
          pronunciation_dictionary_id: path.pronunciation_dictionary_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/pronunciation-dictionaries/{pronunciation_dictionary_id}/remove-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove rules from a pronunciation dictionary
      effect: write
      questions:
      - How do I delete specific words from a pronunciation dictionary?
      - Can I remove several rules at once by their text?
      instructions:
      - text: Remove the rules for {rule_strings} from dictionary {pronunciation_dictionary_id}.
        slots:
          rule_strings: requestBody.rule_strings
          pronunciation_dictionary_id: path.pronunciation_dictionary_id
      - text: Drop pronunciation entries {rule_strings} in {pronunciation_dictionary_id}.
        slots:
          rule_strings: requestBody.rule_strings
          pronunciation_dictionary_id: path.pronunciation_dictionary_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/pronunciation-dictionaries/{dictionary_id}/{version_id}/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a dictionary version as a PLS file
      effect: read
      questions:
      - Can I export a pronunciation dictionary as a PLS lexicon?
      - How do I get the rules of an older dictionary version?
      instructions:
      - text: Download version {version_id} of dictionary {dictionary_id} as PLS.
        slots:
          version_id: path.version_id
          dictionary_id: path.dictionary_id
      - text: Export the PLS file for dictionary {dictionary_id} at version {version_id}.
        slots:
          dictionary_id: path.dictionary_id
          version_id: path.version_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/pronunciation-dictionaries'].get
  update:
    x-apievangelist-phrasing:
      intent: List my pronunciation dictionaries
      effect: read
      questions:
      - Which pronunciation dictionaries do I have access to?
      - Can I include archived dictionaries in the list?
      instructions:
      - text: List all my pronunciation dictionaries.
      - text: List pronunciation dictionaries including archived ones ({include_archived}).
        slots:
          include_archived: query.include_archived
      - text: List my dictionaries sorted by {sort} {sort_direction}.
        slots:
          sort: query.sort
          sort_direction: query.sort_direction
      method: generated
      generated: '2026-09-26'