Relevance AI · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Relevance AI Endpoints Warmup API

5 actions 5 updates phrasing extends openapi/relevance-ai-warmup-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Relevance AI's API. It is a proposal applied on top of the contract, not a document Relevance AI publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/warmup/create'].post
$.paths['/warmup/{email_id}/get'].get
$.paths['/warmup/start'].post
$.paths['/warmup/stop'].post

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 Relevance AI Endpoints Warmup API
  version: 1.0.0
extends: openapi/relevance-ai-warmup-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: 4
- target: $.paths['/warmup/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an email inbox for warmup
      effect: write
      questions:
      - How do I set up a new email address for warmup?
      - Can I control the daily ramp-up and reply rate for a warmup inbox?
      - What's the max emails per day I can set when adding an inbox to warm up?
      instructions:
      - text: Add inbox {email} with sender name {from_name} and password {password} for warmup.
        slots:
          email: requestBody.email
          from_name: requestBody.from_name
          password: requestBody.password
      - text: Register {email} as {from_name} for warmup at up to {max_email_per_day} emails a day, password {password}.
        slots:
          email: requestBody.email
          from_name: requestBody.from_name
          max_email_per_day: requestBody.max_email_per_day
          password: requestBody.password
      method: generated
      generated: '2026-09-26'
- target: $.paths['/warmup/{email_id}/get'].get
  update:
    x-apievangelist-phrasing:
      intent: Get warmup stats for an email
      effect: read
      questions:
      - How is the warmup going for one of my email addresses?
      - Can I include detailed stats when checking a warmup inbox?
      instructions:
      - text: Get warmup stats for email {email_id}.
        slots:
          email_id: path.email_id
      - text: Show warmup details for inbox {email_id} with stats included.
        slots:
          email_id: path.email_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/warmup/start'].post
  update:
    x-apievangelist-phrasing:
      intent: Start warming up an email address
      effect: write
      questions:
      - Can I resume warmup on an address that was paused?
      - What starts sending warmup emails for my inbox?
      instructions:
      - text: Start warmup for {email}.
        slots:
          email: requestBody.email
      - text: Turn on email warmup for the address {email}.
        slots:
          email: requestBody.email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/warmup/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop warming up an email address
      effect: write
      questions:
      - How do I pause warmup for an email address?
      - Can I stop warmup emails going out from one inbox?
      instructions:
      - text: Stop warmup for {email}.
        slots:
          email: requestBody.email
      - text: Turn off email warmup for the address {email}.
        slots:
          email: requestBody.email
      method: generated
      generated: '2026-09-26'