SendGrid · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio SendGrid Email Activity API

5 actions 5 updates phrasing extends openapi/sendgrid-email-activity-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/v3/messages'].get

$.paths['/v3/messages/{msg_id}'].get

$.paths['/v3/messages/download'].post

$.paths['/v3/messages/download/{download_uuid}'].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 Twilio SendGrid Email Activity API
  version: 1.0.0
extends: openapi/sendgrid-email-activity-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/v3/messages'].get
  update:
    x-apievangelist-phrasing:
      intent: Search email activity with a query
      effect: read
      questions:
      - Can I find every message sent to a certain recipient in Email Activity?
      - What query format does the email activity filter expect?
      instructions:
      - text: Search email activity with query {query}.
        slots:
          query: query.query
      - text: Find up to {limit} messages matching {query}.
        slots:
          limit: query.limit
          query: query.query
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/messages/{msg_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get full details of one message
      effect: read
      questions:
      - What happened to a specific email I sent, step by step?
      - Can I see all events for one message ID?
      instructions:
      - text: Get the details of message {msg_id}.
        slots:
          msg_id: path.msg_id
      - text: Show every event recorded for message {msg_id}.
        slots:
          msg_id: path.msg_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/messages/download'].post
  update:
    x-apievangelist-phrasing:
      intent: Request a CSV export of email activity
      effect: write
      questions:
      - Can I export my email activity to a CSV file?
      - How far back does an email activity CSV export go, and how long is the link good for?
      instructions:
      - text: Request a CSV of email activity events.
      - text: Start a CSV export of activity matching {query}.
        slots:
          query: query.query
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/messages/download/{download_uuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the download link for an activity CSV
      effect: read
      questions:
      - Where do I download the email activity CSV I requested?
      - Can I get a presigned link for a finished activity export?
      instructions:
      - text: Get the download URL for CSV export {download_uuid}.
        slots:
          download_uuid: path.download_uuid
      - text: Fetch the presigned link for activity CSV {download_uuid}.
        slots:
          download_uuid: path.download_uuid
      method: generated
      generated: '2026-09-24'