Brevo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Email Inbound Parsing API

4 actions 4 updates phrasing extends openapi/brevo-inboundparsing-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 4

$.info

$.paths['/inbound/events'].get

$.paths['/inbound/events/{uuid}'].get

$.paths['/inbound/attachments/{downloadToken}'].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 Email Inbound Parsing API
  version: 1.0.0
extends: openapi/brevo-inboundparsing-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: 3
- target: $.paths['/inbound/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List inbound email events
      effect: read
      questions:
      - What emails have been received through inbound parsing lately?
      - Can I filter received emails by sender?
      instructions:
      - text: List inbound email events.
      - text: Show received emails from {sender} between {startDate} and {endDate}.
        slots:
          sender: query.sender
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/inbound/events/{uuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the event history of one received email
      effect: read
      questions:
      - What happened to one specific inbound email?
      - Can I see every processing event for a single received message?
      instructions:
      - text: Show the event history of inbound email {uuid}.
        slots:
          uuid: path.uuid
      - text: Get all events for received email {uuid}.
        slots:
          uuid: path.uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/inbound/attachments/{downloadToken}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an inbound email attachment
      effect: read
      questions:
      - How do I download a file attached to a received email?
      - What do I need to fetch an inbound attachment?
      instructions:
      - text: Download the inbound attachment with token {downloadToken}.
        slots:
          downloadToken: path.downloadToken
      - text: Fetch attachment {downloadToken} from a received email.
        slots:
          downloadToken: path.downloadToken
      method: generated
      generated: '2026-09-26'