Brevo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Accounts and Settings Process API

3 actions 3 updates phrasing extends openapi/brevo-process-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['/processes'].get
$.paths['/processes/{processId}'].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 Accounts and Settings Process API
  version: 1.0.0
extends: openapi/brevo-process-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['/processes'].get
  update:
    x-apievangelist-phrasing:
      intent: List background processes
      effect: read
      questions:
      - What imports or exports are running in the background?
      - Can I page through my background processes?
      instructions:
      - text: List my background processes.
      - text: Show {limit} background processes sorted {sort}.
        slots:
          limit: query.limit
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/processes/{processId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a background process
      effect: read
      questions:
      - Has my contact import finished yet?
      - Where do I get the result file of a completed export?
      instructions:
      - text: Show the status of process {processId}.
        slots:
          processId: path.processId
      - text: Check whether process {processId} is complete.
        slots:
          processId: path.processId
      method: generated
      generated: '2026-09-26'