API Reference — subpackage_customPronunciations

naftiko: 1.0.0-alpha2
info:
  label: API Reference — subpackage_customPronunciations
  description: 'API Reference — subpackage_customPronunciations. 6 operations. Lead operation: List custom pronunciations.
    Self-contained Naftiko capability covering one Resemble Ai business surface.'
  tags:
  - Resemble Ai
  - subpackage_customPronunciations
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    RESEMBLE_AI_API_KEY: RESEMBLE_AI_API_KEY
capability:
  consumes:
  - type: http
    namespace: resemble-ai-subpackage-custompronunciations
    baseUri: https://f.cluster.resemble.ai
    description: API Reference — subpackage_customPronunciations business capability. Self-contained, no shared references.
    resources:
    - name: pronunciations
      path: /pronunciations
      operations:
      - name: listpronunciations
        method: GET
        description: List custom pronunciations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: language
          in: query
          type: string
          description: Filter by language (e.g., en-us)
        - name: domain
          in: query
          type: string
          description: Filter by domain (e.g., medical)
        - name: status
          in: query
          type: string
          description: Filter by processing status
        - name: active
          in: query
          type: boolean
          description: Filter by active state
        - name: Authorization
          in: header
          type: string
          description: API token from https://app.resemble.ai/account/api
          required: true
      - name: createpronunciation
        method: POST
        description: Create custom pronunciation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: API token from https://app.resemble.ai/account/api
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: pronunciations-bulk
      path: /pronunciations/bulk
      operations:
      - name: bulkcreatepronunciations
        method: POST
        description: Bulk create pronunciations from ZIP
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: API token from https://app.resemble.ai/account/api
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: pronunciations-uuid
      path: /pronunciations/{uuid}
      operations:
      - name: getpronunciation
        method: GET
        description: Get custom pronunciation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: uuid
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          description: API token from https://app.resemble.ai/account/api
          required: true
      - name: deletepronunciation
        method: DELETE
        description: Delete custom pronunciation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: uuid
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          description: API token from https://app.resemble.ai/account/api
          required: true
      - name: updatepronunciation
        method: PATCH
        description: Toggle pronunciation active status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: uuid
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          description: API token from https://app.resemble.ai/account/api
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: bearer
      token: '{{env.RESEMBLE_AI_API_KEY}}'
  exposes:
  - type: rest
    namespace: resemble-ai-subpackage-custompronunciations-rest
    port: 8080
    description: REST adapter for API Reference — subpackage_customPronunciations. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/pronunciations
      name: pronunciations
      description: REST surface for pronunciations.
      operations:
      - method: GET
        name: listpronunciations
        description: List custom pronunciations
        call: resemble-ai-subpackage-custompronunciations.listpronunciations
        with:
          language: rest.language
          domain: rest.domain
          status: rest.status
          active: rest.active
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createpronunciation
        description: Create custom pronunciation
        call: resemble-ai-subpackage-custompronunciations.createpronunciation
        with:
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/pronunciations/bulk
      name: pronunciations-bulk
      description: REST surface for pronunciations-bulk.
      operations:
      - method: POST
        name: bulkcreatepronunciations
        description: Bulk create pronunciations from ZIP
        call: resemble-ai-subpackage-custompronunciations.bulkcreatepronunciations
        with:
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/pronunciations/{uuid}
      name: pronunciations-uuid
      description: REST surface for pronunciations-uuid.
      operations:
      - method: GET
        name: getpronunciation
        description: Get custom pronunciation
        call: resemble-ai-subpackage-custompronunciations.getpronunciation
        with:
          uuid: rest.uuid
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletepronunciation
        description: Delete custom pronunciation
        call: resemble-ai-subpackage-custompronunciations.deletepronunciation
        with:
          uuid: rest.uuid
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatepronunciation
        description: Toggle pronunciation active status
        call: resemble-ai-subpackage-custompronunciations.updatepronunciation
        with:
          uuid: rest.uuid
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: resemble-ai-subpackage-custompronunciations-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — subpackage_customPronunciations. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: list-custom-pronunciations
      description: List custom pronunciations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: resemble-ai-subpackage-custompronunciations.listpronunciations
      with:
        language: tools.language
        domain: tools.domain
        status: tools.status
        active: tools.active
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: create-custom-pronunciation
      description: Create custom pronunciation
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: resemble-ai-subpackage-custompronunciations.createpronunciation
      with:
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: bulk-create-pronunciations-zip
      description: Bulk create pronunciations from ZIP
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: resemble-ai-subpackage-custompronunciations.bulkcreatepronunciations
      with:
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-custom-pronunciation
      description: Get custom pronunciation
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: resemble-ai-subpackage-custompronunciations.getpronunciation
      with:
        uuid: tools.uuid
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-custom-pronunciation
      description: Delete custom pronunciation
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: resemble-ai-subpackage-custompronunciations.deletepronunciation
      with:
        uuid: tools.uuid
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: toggle-pronunciation-active-status
      description: Toggle pronunciation active status
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: resemble-ai-subpackage-custompronunciations.updatepronunciation
      with:
        uuid: tools.uuid
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.