Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online API Keys (tenant-scoped) API

9 actions 9 updates phrasing extends openapi/live-direct-marketing-online-api-keys-tenant-scoped-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/api-keys'].get

$.paths['/api/api-keys'].post

$.paths['/api/api-keys/whoami'].get

$.paths['/api/api-keys/{id}/reveal'].get

$.paths['/api/api-keys/scopes/structured'].get

$.paths['/api/api-keys/{id}'].delete

$.paths['/api/api-keys/{id}'].patch

$.paths['/api/api-keys/{id}/revoke'].delete

OpenAPI Overlay

# 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 API Keys (tenant-scoped) API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-api-keys-tenant-scoped-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/api-keys'].get
  update:
    x-apievangelist-phrasing:
      intent: List tenant API keys
      effect: read
      questions:
      - What API keys exist for my workspace?
      - Does the key list show the secret values?
      instructions:
      - text: List my tenant API keys.
      - text: Show every API key on this account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/api-keys'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a tenant API key
      effect: write
      questions:
      - How do I create an API key for an AI agent?
      - Can a new key act as me so it can compose and reply to email?
      instructions:
      - text: Create a new tenant API key.
      - text: Make an API key bound to my user so it can act as me.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/api-keys/whoami'].get
  update:
    x-apievangelist-phrasing:
      intent: Check which key I'm using
      effect: read
      questions:
      - Are my current credentials valid, and which tenant are they connected to?
      - How can an agent confirm its API key works before making calls?
      instructions:
      - text: Check who I am with the current API key.
      - text: Verify my bearer credentials and show where they connect.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/api-keys/{id}/reveal'].get
  update:
    x-apievangelist-phrasing:
      intent: Reveal an API key's secret value
      effect: read
      questions:
      - Can I see the raw value of an API key I created earlier?
      - Why can't one API key reveal another key's secret?
      instructions:
      - text: Reveal the secret of API key {id}.
        slots:
          id: path.id
      - text: Show me the raw value of key {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/api-keys/scopes/structured'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the API key scope catalog
      effect: read
      questions:
      - Which scopes can I grant to an API key, and which are dangerous?
      - Are there preset scope bundles like read-only or AI agent?
      instructions:
      - text: Show the structured scope catalog for API keys.
      - text: List the scope presets and grouped scope definitions.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/api-keys/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Permanently delete an API key
      effect: destructive
      questions:
      - How do I permanently delete an API key?
      - What's the difference between deleting a key and revoking it?
      instructions:
      - text: Permanently delete API key {id}.
        slots:
          id: path.id
      - text: Erase key {id} for good.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/api-keys/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Toggle act-as-me on an API key
      effect: write
      questions:
      - Can I upgrade an existing key to act as me without changing its value?
      - Will clients using a key break if I turn on act-as-me?
      instructions:
      - text: Turn on act-as-me for API key {id}.
        slots:
          id: path.id
      - text: Unset act-as-me on key {id} in place.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/api-keys/{id}/revoke'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke an API key
      effect: destructive
      questions:
      - Can I deactivate an API key but keep its record?
      - How do I stop a leaked key from working without deleting it?
      instructions:
      - text: Revoke API key {id}.
        slots:
          id: path.id
      - text: Deactivate key {id} but keep it on file.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'