Telnyx API — Voice Designs

naftiko: 1.0.0-alpha2
info:
  label: Telnyx API — Voice Designs
  description: 'Telnyx API — Voice Designs. 7 operations. Lead operation: List voice designs. Self-contained Naftiko capability
    covering one Telnyx business surface.'
  tags:
  - Telnyx
  - Voice Designs
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TELNYX_API_KEY: TELNYX_API_KEY
capability:
  consumes:
  - type: http
    namespace: telnyx-voice-designs
    baseUri: https://api.telnyx.com/v2
    description: Telnyx API — Voice Designs business capability. Self-contained, no shared references.
    resources:
    - name: voice_designs
      path: /voice_designs
      operations:
      - name: listvoicedesigns
        method: GET
        description: List voice designs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createvoicedesign
        method: POST
        description: Create or add a version to a voice design
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: voice_designs-id
      path: /voice_designs/{id}
      operations:
      - name: deletevoicedesign
        method: DELETE
        description: Delete a voice design
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The voice design UUID or name.
          required: true
      - name: getvoicedesign
        method: GET
        description: Get a voice design
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The voice design UUID or name.
          required: true
        - name: version
          in: query
          type: integer
          description: Specific version number to retrieve. Defaults to the latest version.
      - name: updatevoicedesign
        method: PATCH
        description: Rename a voice design
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The voice design UUID or name.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: voice_designs-id-sample
      path: /voice_designs/{id}/sample
      operations:
      - name: getvoicedesignsample
        method: GET
        description: Download voice design audio sample
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The voice design UUID or name.
          required: true
        - name: version
          in: query
          type: integer
          description: Specific version number to download the sample for. Defaults to the latest version.
    - name: voice_designs-id-versions-version
      path: /voice_designs/{id}/versions/{version}
      operations:
      - name: deletevoicedesignversion
        method: DELETE
        description: Delete a specific version of a voice design
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The voice design UUID or name.
          required: true
        - name: version
          in: path
          type: integer
          description: The version number to delete.
          required: true
    authentication:
      type: bearer
      token: '{{env.TELNYX_API_KEY}}'
  exposes:
  - type: rest
    namespace: telnyx-voice-designs-rest
    port: 8080
    description: REST adapter for Telnyx API — Voice Designs. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/voice-designs
      name: voice-designs
      description: REST surface for voice_designs.
      operations:
      - method: GET
        name: listvoicedesigns
        description: List voice designs
        call: telnyx-voice-designs.listvoicedesigns
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createvoicedesign
        description: Create or add a version to a voice design
        call: telnyx-voice-designs.createvoicedesign
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/voice-designs/{id}
      name: voice-designs-id
      description: REST surface for voice_designs-id.
      operations:
      - method: DELETE
        name: deletevoicedesign
        description: Delete a voice design
        call: telnyx-voice-designs.deletevoicedesign
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getvoicedesign
        description: Get a voice design
        call: telnyx-voice-designs.getvoicedesign
        with:
          id: rest.id
          version: rest.version
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatevoicedesign
        description: Rename a voice design
        call: telnyx-voice-designs.updatevoicedesign
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/voice-designs/{id}/sample
      name: voice-designs-id-sample
      description: REST surface for voice_designs-id-sample.
      operations:
      - method: GET
        name: getvoicedesignsample
        description: Download voice design audio sample
        call: telnyx-voice-designs.getvoicedesignsample
        with:
          id: rest.id
          version: rest.version
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/voice-designs/{id}/versions/{version}
      name: voice-designs-id-versions-version
      description: REST surface for voice_designs-id-versions-version.
      operations:
      - method: DELETE
        name: deletevoicedesignversion
        description: Delete a specific version of a voice design
        call: telnyx-voice-designs.deletevoicedesignversion
        with:
          id: rest.id
          version: rest.version
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: telnyx-voice-designs-mcp
    port: 9090
    transport: http
    description: MCP adapter for Telnyx API — Voice Designs. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-voice-designs
      description: List voice designs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-voice-designs.listvoicedesigns
      outputParameters:
      - type: object
        mapping: $.
    - name: create-add-version-voice-design
      description: Create or add a version to a voice design
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-voice-designs.createvoicedesign
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-voice-design
      description: Delete a voice design
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: telnyx-voice-designs.deletevoicedesign
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: get-voice-design
      description: Get a voice design
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-voice-designs.getvoicedesign
      with:
        id: tools.id
        version: tools.version
      outputParameters:
      - type: object
        mapping: $.
    - name: rename-voice-design
      description: Rename a voice design
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: telnyx-voice-designs.updatevoicedesign
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: download-voice-design-audio-sample
      description: Download voice design audio sample
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-voice-designs.getvoicedesignsample
      with:
        id: tools.id
        version: tools.version
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-specific-version-voice-design
      description: Delete a specific version of a voice design
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: telnyx-voice-designs.deletevoicedesignversion
      with:
        id: tools.id
        version: tools.version
      outputParameters:
      - type: object
        mapping: $.