# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Klaviyo Forms API
  version: 1.0.0
extends: openapi/klaviyo-forms-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['/api/forms'].get
  update:
    x-apievangelist-phrasing:
      intent: List signup forms
      effect: read
      questions:
      - What signup forms and popups do I have in Klaviyo?
      - Can I filter my forms by status or name?
      instructions:
      - text: List forms matching {filter}.
        slots:
          filter: query.filter
      - text: Show all forms sorted by {sort}.
        slots:
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/forms'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a signup form
      effect: write
      questions:
      - How do I create a new signup form through the API?
      - Can I build a popup form programmatically?
      instructions:
      - text: Create a form {form}.
        slots:
          form: requestBody.data
      - text: Build a new signup form from {form}.
        slots:
          form: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/forms/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one signup form
      effect: read
      questions:
      - What are the details of a specific form?
      - Can I look up a form by its ID?
      instructions:
      - text: Get form {form_id}.
        slots:
          form_id: path.id
      - text: Show the settings of signup form {form_id}.
        slots:
          form_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/forms/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a signup form
      effect: destructive
      questions:
      - Can I delete a form I no longer use?
      - What's the way to permanently remove a popup form?
      instructions:
      - text: Delete form {form_id}.
        slots:
          form_id: path.id
      - text: Permanently remove signup form {form_id}.
        slots:
          form_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/form-versions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one form version
      effect: read
      questions:
      - What does a specific version of a form look like?
      - Can I fetch a single form version by ID?
      instructions:
      - text: Get form version {version_id}.
        slots:
          version_id: path.id
      - text: Show the details of form version {version_id}.
        slots:
          version_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/forms/{id}/form-versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List the versions of a form
      effect: read
      questions:
      - What versions exist for a particular form, like A/B variations?
      - Can I see full details of every version of one form?
      instructions:
      - text: List the versions of form {form_id}.
        slots:
          form_id: path.id
      - text: Show every version of form {form_id} matching {filter}.
        slots:
          form_id: path.id
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/forms/{id}/relationships/form-versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List version IDs for a form
      effect: read
      questions:
      - Can I get only the version IDs for a form?
      - Which version IDs belong to one form?
      instructions:
      - text: Get only the version IDs of form {form_id}.
        slots:
          form_id: path.id
      - text: Return the version ID list for form {form_id}.
        slots:
          form_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/form-versions/{id}/form'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the form a version belongs to
      effect: read
      questions:
      - Which form does a given form version belong to?
      - Can I get the full parent form from a version ID?
      instructions:
      - text: Get the form for version {version_id}.
        slots:
          version_id: path.id
      - text: Fetch the signup form that owns version {version_id}.
        slots:
          version_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/form-versions/{id}/relationships/form'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the form ID for a form version
      effect: read
      questions:
      - Can I get only the parent form ID for a version?
      - What's the form ID behind a particular form version?
      instructions:
      - text: Get only the form ID for version {version_id}.
        slots:
          version_id: path.id
      - text: Return the parent form ID of version {version_id}.
        slots:
          version_id: path.id
      method: generated
      generated: '2026-09-26'