Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Custom Extract API

3 actions 3 updates phrasing extends openapi/live-direct-marketing-online-custom-extract-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 3

$.info
$.paths['/api/custom-extract'].post
$.paths['/api/custom-extract/{jobId}'].get

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 Custom Extract API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-custom-extract-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: 2
- target: $.paths['/api/custom-extract'].post
  update:
    x-apievangelist-phrasing:
      intent: Extract data with a keyword, regex or prompt
      effect: write
      questions:
      - Can I pull specific information out of text I already have using a regex?
      - How do I run an AI prompt to extract details from supplied material?
      instructions:
      - text: Extract from {material} using rule {rule}.
        slots:
          material: requestBody.material
          rule: requestBody.rule
      - text: Run extraction rule {rule} against context {contextId}.
        slots:
          rule: requestBody.rule
          contextId: requestBody.contextId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/custom-extract/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a prompt extraction job result
      effect: read
      questions:
      - Has my AI prompt extraction job finished?
      - Where do I get the result of a queued custom extraction?
      instructions:
      - text: Get the status and result of extraction job {jobId}.
        slots:
          jobId: path.jobId
      - text: Check whether prompt extraction {jobId} is done.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-10-01'