# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for llm-api Form Interface API
  version: 1.0.0
extends: openapi/treasure-data-forminterface-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: 5
- target: $.paths['/api/form_interfaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List form interfaces for AI agents
      effect: read
      questions:
      - Which form interfaces exist in my Treasure Data AI projects?
      - Can I filter form interfaces by project or by name?
      - How do I see every form interface sorted by name?
      instructions:
      - text: List all form interfaces in project {project_id}.
        slots:
          project_id: query.filter[project_id]
      - text: Find form interfaces named {name}.
        slots:
          name: query.filter[name]
      - text: List my form interfaces sorted by {sort}.
        slots:
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/form_interfaces'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a form interface
      effect: write
      questions:
      - Can I build a form front end that feeds inputs to an AI agent?
      - What do I need to send to create a new form interface?
      instructions:
      - text: 'Create a new form interface with these settings: {data}.'
        slots:
          data: requestBody.data
      - text: Set up a form interface for my agent project using {data}.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/form_interfaces/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one form interface
      effect: read
      questions:
      - What is configured on a specific form interface?
      - Can I look up a single form interface by its ID?
      instructions:
      - text: Show me the details of form interface {id}.
        slots:
          id: path.id
      - text: Fetch form interface {id} so I can review its fields.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/form_interfaces/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a form interface
      effect: destructive
      questions:
      - How do I remove a form interface I no longer use?
      - Is deleting a form interface permanent?
      instructions:
      - text: Delete form interface {id}.
        slots:
          id: path.id
      - text: Remove the obsolete form interface {id} from my project.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/form_interfaces/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a form interface
      effect: write
      questions:
      - Can I change the fields on an existing form interface?
      - What happens to a form interface when I edit its settings?
      instructions:
      - text: Update form interface {id} with {data}.
        slots:
          id: path.id
          data: requestBody.data
      - text: Edit the settings of existing form interface {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'