Brevo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Accounts and Settings Account API

3 actions 3 updates phrasing extends openapi/brevo-account-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Brevo's API. It is a proposal applied on top of the contract, not a document Brevo publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/account'].get

$.paths['/organization/activities'].get

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 Accounts and Settings Account API
  version: 1.0.0
extends: openapi/brevo-account-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/account'].get
  update:
    x-apievangelist-phrasing:
      intent: Get account and plan details
      effect: read
      questions:
      - How many email credits are left on my Brevo plan?
      - What company name and address are on my account?
      instructions:
      - text: Show my account details.
      - text: Get the plan and credits for the account with API key {api_key}.
        slots:
          api_key: header.api-key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organization/activities'].get
  update:
    x-apievangelist-phrasing:
      intent: Get user activity logs
      effect: read
      questions:
      - Who logged in to our account recently and from where?
      - Can I audit the actions of one team member?
      instructions:
      - text: Show user activity logs from {startDate} to {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      - text: List the activity of user {email}.
        slots:
          email: query.email
      method: generated
      generated: '2026-09-26'