Relevance AI · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Relevance AI Endpoints Integrations API

3 actions 3 updates phrasing extends openapi/relevance-ai-integrations-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 3

$.info

$.paths['/integrations/slack/{account_id}/email/{email}'].get

$.paths['/slack/agents/webhook'].post

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 Relevance AI Endpoints Integrations API
  version: 1.0.0
extends: openapi/relevance-ai-integrations-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['/integrations/slack/{account_id}/email/{email}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up and validate a Slack user's email
      effect: read
      questions:
      - Can I check whether an email belongs to a user in my connected Slack workspace?
      - How do I validate a Slack email before an agent messages that person?
      instructions:
      - text: Look up email {email} in Slack account {account_id}.
        slots:
          email: path.email
          account_id: path.account_id
      - text: Validate that {email} is a Slack user on connected account {account_id}.
        slots:
          email: path.email
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/slack/agents/webhook'].post
  update:
    x-apievangelist-phrasing:
      intent: List agents triggerable from a Slack channel
      effect: read
      questions:
      - Which agents can be triggered from a given Slack channel via slash command?
      - What does the Slack slash command webhook return for a channel?
      instructions:
      - text: List agents triggerable from Slack channel {channel_id} in team {team_id}, replying to {response_url}.
        slots:
          channel_id: requestBody.channel_id
          team_id: requestBody.team_id
          response_url: requestBody.response_url
      - text: Handle the slash command {command} from channel {channel_id} in workspace {team_id} and respond at {response_url}.
        slots:
          command: requestBody.command
          channel_id: requestBody.channel_id
          team_id: requestBody.team_id
          response_url: requestBody.response_url
      method: generated
      generated: '2026-09-26'