# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Contentstack Brand Kit Management Voice Profiles API
  version: 1.0.0
extends: openapi/contentstack-voice-profiles-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: 5
- target: $.paths['/v1/brand-kits/{brand_kit_uid}/voice-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List a Brand Kit's voice profiles
      effect: read
      questions:
      - Which voice profiles are attached to my Brand Kit?
      - How do I see all the writing tones defined for a Brand Kit?
      instructions:
      - text: List voice profiles in Brand Kit {brand_kit} for org {org}.
        slots:
          brand_kit: path.brand_kit_uid
          org: header.organization_uid
      - text: Show every Voice Profile of Brand Kit {brand_kit} in organization {org}.
        slots:
          brand_kit: path.brand_kit_uid
          org: header.organization_uid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/brand-kits/{brand_kit_uid}/voice-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a voice profile
      effect: write
      questions:
      - How do I define a writing tone for AI-generated content in a Brand Kit?
      - Can I add style guidelines to a new voice profile?
      instructions:
      - text: Create voice profile {name} in Brand Kit {brand_kit} for org {org}.
        slots:
          name: requestBody.name
          brand_kit: path.brand_kit_uid
          org: header.organization_uid
      - text: Add Voice Profile {name} with tone {tone} and guidelines {guidelines} to Brand Kit {brand_kit} in org {org}.
        slots:
          name: requestBody.name
          tone: requestBody.tone
          guidelines: requestBody.style_guidelines
          brand_kit: path.brand_kit_uid
          org: header.organization_uid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/brand-kits/{brand_kit_uid}/voice-profiles/{profile_uid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a voice profile
      effect: read
      questions:
      - How do I view the tone and style guidelines of one voice profile?
      - What example content is stored in a given voice profile?
      instructions:
      - text: Show voice profile {profile} in Brand Kit {brand_kit} for org {org}.
        slots:
          profile: path.profile_uid
          brand_kit: path.brand_kit_uid
          org: header.organization_uid
      - text: Get the tone settings of Voice Profile {profile} in Brand Kit {brand_kit}, org {org}.
        slots:
          profile: path.profile_uid
          brand_kit: path.brand_kit_uid
          org: header.organization_uid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/brand-kits/{brand_kit_uid}/voice-profiles/{profile_uid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a voice profile
      effect: write
      questions:
      - Can I change the tone of an existing voice profile?
      - How do I revise the style guidelines on a voice profile?
      instructions:
      - text: Rename voice profile {profile} in Brand Kit {brand_kit}, org {org}, to {name}.
        slots:
          profile: path.profile_uid
          brand_kit: path.brand_kit_uid
          org: header.organization_uid
          name: requestBody.name
      - text: Set tone {tone} on Voice Profile {profile} ({name}) in Brand Kit {brand_kit}, org {org}.
        slots:
          tone: requestBody.tone
          profile: path.profile_uid
          name: requestBody.name
          brand_kit: path.brand_kit_uid
          org: header.organization_uid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/brand-kits/{brand_kit_uid}/voice-profiles/{profile_uid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a voice profile
      effect: destructive
      questions:
      - How do I remove a voice profile from a Brand Kit?
      - Can a deleted voice profile be restored?
      instructions:
      - text: Delete voice profile {profile} from Brand Kit {brand_kit} in org {org}.
        slots:
          profile: path.profile_uid
          brand_kit: path.brand_kit_uid
          org: header.organization_uid
      - text: Permanently remove Voice Profile {profile} of Brand Kit {brand_kit}, org {org}.
        slots:
          profile: path.profile_uid
          brand_kit: path.brand_kit_uid
          org: header.organization_uid
      method: generated
      generated: '2026-09-26'