# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Forms API
  version: 1.0.0
extends: openapi/vendasta-forms-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/v1/forms/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a lead capture form
      effect: write
      questions:
      - How do I build a new contact form with name, email and message fields?
      - Can a form's fields map straight into CRM contact fields?
      - Do I need to add UTM tracking fields myself when creating a form?
      instructions:
      - text: Create a form with configuration {config}.
        slots:
          config: requestBody.formConfig
      - text: Build a new contact form using {config} with required name and email fields.
        slots:
          config: requestBody.formConfig
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/forms/embed-code'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the embed code for a form
      effect: read
      questions:
      - Where do I get the snippet to put a form on my website?
      - Can I embed a form I just created on any webpage?
      instructions:
      - text: Get the embed code for form {form}.
        slots:
          form: requestBody.formId
      - text: Give me the HTML snippet to place form {form} on a page.
        slots:
          form: requestBody.formId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/forms/generate-custom-css'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate custom CSS styling for a form with AI
      effect: write
      questions:
      - Can I describe a look in plain words and get CSS styles generated for my form?
      - Is it possible to give reference images when generating form styling?
      instructions:
      - text: Generate form CSS in namespace {namespace} from the prompt {prompt}.
        slots:
          namespace: requestBody.namespace
          prompt: requestBody.prompt
      - text: Style form {form} in namespace {namespace} to match {prompt} using images {images}.
        slots:
          form: requestBody.formId
          namespace: requestBody.namespace
          prompt: requestBody.prompt
          images: requestBody.imageUrls
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/forms/get'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a form's configuration
      effect: read
      questions:
      - What fields and settings does an existing form have?
      - Can I read a form's configuration in a particular language?
      instructions:
      - text: Get form {form}.
        slots:
          form: requestBody.formId
      - text: Show the configuration of form {form} in locale {locale}.
        slots:
          form: requestBody.formId
          locale: requestBody.locale
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/forms/has-enterprise-api-key'].get
  update:
    x-apievangelist-phrasing:
      intent: Check for a reCAPTCHA Enterprise key in a namespace
      effect: read
      questions:
      - Does this namespace already have an enterprise API key set up for forms?
      - Is reCAPTCHA Enterprise already configured before I provision it?
      instructions:
      - text: Check whether namespace {namespace} has an enterprise API key.
        slots:
          namespace: query.namespace
      - text: Tell me if forms in {namespace} already have an enterprise key configured.
        slots:
          namespace: query.namespace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/forms/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List and search forms
      effect: read
      questions:
      - What forms have been created so far?
      - Can I search my forms by name?
      instructions:
      - text: List all my forms.
      - text: Search forms matching {term}.
        slots:
          term: requestBody.searchTerm
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/forms/mapped-field-schema/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List CRM fields a form can map to
      effect: read
      questions:
      - Which CRM contact or company fields can a form field be mapped to?
      - What mapped field types exist besides contact and company, like special attributes?
      instructions:
      - text: List the mappable CRM fields in namespace {namespace}.
        slots:
          namespace: requestBody.namespace
      - text: Show {resource} fields available for form mapping in namespace {namespace}.
        slots:
          resource: requestBody.mappedToResource
          namespace: requestBody.namespace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/forms/provision-recaptcha-enterprise'].post
  update:
    x-apievangelist-phrasing:
      intent: Turn on reCAPTCHA Enterprise for a form
      effect: write
      questions:
      - How can I protect a form from spam with reCAPTCHA Enterprise?
      - Which domain do I need to supply when enabling reCAPTCHA on a form?
      instructions:
      - text: Provision reCAPTCHA Enterprise for form {form} on domain {domain}.
        slots:
          form: requestBody.formId
          domain: requestBody.domain
      - text: Enable spam protection on form {form} for {domain}.
        slots:
          form: requestBody.formId
          domain: requestBody.domain
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/forms/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an existing form
      effect: write
      questions:
      - Can I add a field to a form that's already live?
      - Is generated CSS applied by updating the form?
      instructions:
      - text: Update the form using configuration {config}.
        slots:
          config: requestBody.formConfig
      - text: Apply new styles and fields to my existing form with {config}.
        slots:
          config: requestBody.formConfig
      method: generated
      generated: '2026-10-01'