Brevo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sales CRM Files API

6 actions 6 updates phrasing extends openapi/brevo-files-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 6

$.info

$.paths['/crm/files'].get

$.paths['/crm/files'].post

$.paths['/crm/files/{id}'].get

$.paths['/crm/files/{id}'].delete

$.paths['/crm/files/{id}/data'].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 Sales CRM Files API
  version: 1.0.0
extends: openapi/brevo-files-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: 5
- target: $.paths['/crm/files'].get
  update:
    x-apievangelist-phrasing:
      intent: List CRM files
      effect: read
      questions:
      - Which files are attached to my CRM contacts, companies or deals?
      - Can I list files uploaded within a date range?
      instructions:
      - text: List all my CRM files.
      - text: Show files attached to {entity} {entityIds}.
        slots:
          entity: query.entity
          entityIds: query.entityIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/files'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a file to the CRM
      effect: write
      questions:
      - How do I attach a document to a deal or contact?
      - What's the maximum file size for a CRM upload?
      instructions:
      - text: Upload {file} to the CRM.
        slots:
          file: requestBody.file
      - text: Attach {file} to deal {dealId}.
        slots:
          file: requestBody.file
          dealId: requestBody.dealId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/files/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a download link for a file
      effect: read
      questions:
      - How do I download a CRM file?
      - How long is a file download URL valid?
      instructions:
      - text: Get a download link for file {id}.
        slots:
          id: path.id
      - text: Download CRM file {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/files/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a CRM file
      effect: destructive
      questions:
      - Does deleting a file unlink it from contacts and deals?
      - Can I permanently remove an uploaded CRM file?
      instructions:
      - text: Delete file {id}.
        slots:
          id: path.id
      - text: Permanently remove CRM file {id} from storage.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/files/{id}/data'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a file's metadata
      effect: read
      questions:
      - What is the size, type and linked records of a CRM file?
      - Can I see a file's details without downloading it?
      instructions:
      - text: Show the metadata of file {id}.
        slots:
          id: path.id
      - text: Get name, size and linked entities of file {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'