# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for SMTP2GO API KEYS API
  version: 1.0.0
extends: openapi/smtp2go-api-keys-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_keys/add'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new API key
      effect: write
      questions:
      - How do I create a new SMTP2GO API key?
      - Can I give a new API key its own rate limit and restrict it to certain endpoints?
      - Is there a limit on how often I can generate API keys?
      instructions:
      - text: Create an API key described as {description}.
        slots:
          description: requestBody.description
      - text: Create an API key limited to the endpoints {endpoints}.
        slots:
          endpoints: requestBody.endpoints
      - text: Create a new API key for subaccount {subaccount_id}.
        slots:
          subaccount_id: requestBody.subaccount_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api_keys/edit'].post
  update:
    x-apievangelist-phrasing:
      intent: Replace an API key's settings
      effect: write
      questions:
      - How do I update all the settings of an existing API key at once?
      - Can I disable open and click tracking on a key with a full edit?
      instructions:
      - text: Edit API key {id} and set its description to {description}.
        slots:
          id: requestBody.id
          description: requestBody.description
      - text: Do a full edit of API key {id} to change its status to {status}.
        slots:
          id: requestBody.id
          status: requestBody.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api_keys/edit'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update an API key
      effect: write
      questions:
      - Can I change just one setting on an API key without resending everything?
      - What's the way to patch only the IP pool on an existing key?
      instructions:
      - text: Patch API key {id}, changing only its ip_pool to {ip_pool}.
        slots:
          id: requestBody.id
          ip_pool: requestBody.ip_pool
      - text: Patch only the archive setting on key {id} to {archive_enabled}.
        slots:
          id: requestBody.id
          archive_enabled: requestBody.archive_enabled
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api_keys/permissions'].post
  update:
    x-apievangelist-phrasing:
      intent: List endpoints the current key can call
      effect: read
      questions:
      - Which endpoints is the API key I'm using allowed to call?
      - Can I check my current key's permissions?
      instructions:
      - text: Show the endpoints my current API key has permission to use.
      - text: List the permissions of this API key.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api_keys/remove'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete an API key
      effect: destructive
      questions:
      - How do I revoke an API key I no longer need?
      - Can I delete an API key that belongs to a subaccount?
      instructions:
      - text: Remove API key {id}.
        slots:
          id: requestBody.id
      - text: Delete API key {id} from subaccount {subaccount_id}.
        slots:
          id: requestBody.id
          subaccount_id: requestBody.subaccount_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api_keys/view'].post
  update:
    x-apievangelist-phrasing:
      intent: List API keys on the account
      effect: read
      questions:
      - What API keys exist on my account?
      - Can I search my API keys by description?
      instructions:
      - text: List all API keys on my account.
      - text: Find API keys matching {search}.
        slots:
          search: requestBody.search
      - text: Show the details of API key {id}.
        slots:
          id: requestBody.id
      method: generated
      generated: '2026-10-01'