Ada · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Ada Messages API

3 actions 3 updates phrasing extends openapi/ada-messages-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/v2/export/messages'].get

$.paths['/data_api/v1.4/messages'].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 Ada Messages API
  version: 1.0.0
extends: openapi/ada-messages-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['/v2/export/messages'].get
  update:
    x-apievangelist-phrasing:
      intent: Export messages in bulk (v2 export)
      effect: read
      questions:
      - How do I export all messages created in a date range from the v2 export?
      - Can I export only the messages from one conversation via the v2 export?
      instructions:
      - text: Export messages created since {created_since} using the v2 export.
        slots:
          created_since: query.created_since
      - text: Pull v2 export messages for conversation {conversation_id} created between {created_since} and {created_to}.
        slots:
          conversation_id: query.conversation_id
          created_since: query.created_since
          created_to: query.created_to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data_api/v1.4/messages'].get
  update:
    x-apievangelist-phrasing:
      intent: Export messages via the legacy Data API v1.4
      effect: read
      questions:
      - How do I pull messages from the older Data API v1.4?
      - What timestamp format does the legacy v1.4 messages export expect?
      instructions:
      - text: Use the legacy Data API v1.4 to fetch messages created since {created_since}.
        slots:
          created_since: query.created_since
      - text: Fetch Data API v1.4 messages for conversation {conversation_id} since {created_since}, {page_size} per page.
        slots:
          conversation_id: query.conversation_id
          created_since: query.created_since
          page_size: query.page_size
      method: generated
      generated: '2026-09-26'