Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Prompt Templates API

7 actions 7 updates phrasing extends openapi/live-direct-marketing-online-prompt-templates-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Live Direct Marketing's API. It is a proposal applied on top of the contract, not a document Live Direct Marketing publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/api/prompt-templates'].get
$.paths['/api/prompt-templates'].post
$.paths['/api/prompt-templates/{id}'].get
$.paths['/api/prompt-templates/{id}'].delete
$.paths['/api/prompt-templates/{id}'].patch
$.paths['/api/prompt-templates/{idOrName}/render'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Live Direct Marketing Online Prompt Templates API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-prompt-templates-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: 6
- target: $.paths['/api/prompt-templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List prompt templates
      effect: read
      questions:
      - Which AI prompt templates do I have, and which are active?
      - Can I filter prompt templates by kind?
      instructions:
      - text: List prompt templates of kind {kind}.
        slots:
          kind: query.kind
      - text: Show page {page} of active prompt templates, {pageSize} per page.
        slots:
          page: query.page
          pageSize: query.pageSize
      - text: List prompt templates where active is {isActive}.
        slots:
          isActive: query.isActive
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/prompt-templates'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a prompt template
      effect: write
      questions:
      - How do I save a new reusable AI prompt template?
      - Can I add my own prompt template for email generation?
      instructions:
      - text: Create a new prompt template.
      - text: Save this prompt as a reusable template.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/prompt-templates/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a prompt template
      effect: read
      questions:
      - Can I view the text of one prompt template?
      - How do I look up a prompt template by id?
      instructions:
      - text: Get prompt template {id}.
        slots:
          id: path.id
      - text: Show the contents of prompt template {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/prompt-templates/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a prompt template
      effect: destructive
      questions:
      - Can I delete a prompt template I no longer use?
      - Is removing a prompt template permanent?
      instructions:
      - text: Delete prompt template {id}.
        slots:
          id: path.id
      - text: Remove prompt template {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/prompt-templates/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a prompt template
      effect: write
      questions:
      - How do I edit an existing prompt template?
      - Can I deactivate a prompt template without deleting it?
      instructions:
      - text: Update prompt template {id}.
        slots:
          id: path.id
      - text: Edit the wording of prompt template {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/prompt-templates/{idOrName}/render'].post
  update:
    x-apievangelist-phrasing:
      intent: Render a prompt template with variables
      effect: read
      questions:
      - Can I fill in a prompt template's variables to see the final prompt?
      - Can I render a prompt template by its name instead of its id?
      instructions:
      - text: Render prompt template {idOrName} with my variables.
        slots:
          idOrName: path.idOrName
      - text: Preview the filled-in prompt for template {idOrName}.
        slots:
          idOrName: path.idOrName
      method: generated
      generated: '2026-10-01'