Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online AI API

9 actions 9 updates phrasing extends openapi/live-direct-marketing-online-ai-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 9

$.info
$.paths['/api/ai/generate'].post
$.paths['/api/ai/balance'].get
$.paths['/api/ai/balances'].get
$.paths['/api/ai/usage'].get
$.paths['/api/ai/logs'].get
$.paths['/api/ai/providers'].get
$.paths['/api/ai/models'].get
$.paths['/api/ai/check-balance'].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 AI API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-ai-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: 8
- target: $.paths['/api/ai/generate'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate an AI text completion
      effect: write
      questions:
      - Can I run a text completion through my configured AI provider?
      - Which AI provider is used when I ask for a generation?
      instructions:
      - text: Generate an AI completion for this prompt.
      - text: Run a completion through my configured AI provider.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/ai/balance'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the balance of an AI provider
      effect: read
      questions:
      - How much credit is left on one of my AI providers?
      - Can I check the balance of a specific AI provider?
      instructions:
      - text: Show the balance for AI provider {provider}.
        slots:
          provider: query.provider
      - text: Check remaining credit on {provider}.
        slots:
          provider: query.provider
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/ai/balances'].get
  update:
    x-apievangelist-phrasing:
      intent: Check balances across all AI providers
      effect: read
      questions:
      - What are the balances on all my configured AI providers at once?
      - Is any of my AI providers running low on credit?
      instructions:
      - text: Show balances for every configured AI provider.
      - text: List all AI provider balances.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/ai/usage'].get
  update:
    x-apievangelist-phrasing:
      intent: Get AI usage statistics
      effect: read
      questions:
      - How much AI have I used over the last month?
      - Can I see AI usage stats for a custom number of days?
      instructions:
      - text: Show AI usage for the last {days} days.
        slots:
          days: query.days
      - text: Summarize AI consumption over {days} days.
        slots:
          days: query.days
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/ai/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Read recent AI usage logs
      effect: read
      questions:
      - Where can I see the individual AI calls that were made recently?
      - Can I limit how many recent AI log entries come back?
      instructions:
      - text: Show the last {limit} AI usage log entries.
        slots:
          limit: query.limit
      - text: List my recent AI calls.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/ai/providers'].get
  update:
    x-apievangelist-phrasing:
      intent: List AI providers and their status
      effect: read
      questions:
      - Which AI providers are available and are they working?
      - Can I see the status of each AI provider?
      instructions:
      - text: List available AI providers with status.
      - text: Show which AI providers are online.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/ai/models'].get
  update:
    x-apievangelist-phrasing:
      intent: List AI models per provider
      effect: read
      questions:
      - Which AI models can I choose from for each provider?
      - Is the list of AI models fetched live from the providers?
      instructions:
      - text: List available AI models per provider.
      - text: Show the models each AI provider offers.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/ai/check-balance'].post
  update:
    x-apievangelist-phrasing:
      intent: Check AI balance against an alert threshold
      effect: read
      questions:
      - Is there a monitoring hook that checks whether my AI balance fell below a threshold?
      - Can a cron job check AI credit levels automatically?
      instructions:
      - text: Check AI balances against the low-balance threshold.
      - text: Run the AI balance threshold check.
      method: generated
      generated: '2026-10-01'