Relevance AI · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Relevance AI Endpoints Alarms API

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

$.info

$.paths['/alarms/{resource_type}/{resource_id}'].post

$.paths['/alarms/{resource_type}/{resource_id}/list'].post

$.paths['/alarms/{resource_type}/{resource_id}/{alarm_id}'].get

$.paths['/alarms/{resource_type}/{resource_id}/{alarm_id}'].put

$.paths['/alarms/{resource_type}/{resource_id}/{alarm_id}'].delete

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 Alarms API
  version: 1.0.0
extends: openapi/relevance-ai-alarms-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['/alarms/{resource_type}/{resource_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an alarm for an agent or workforce
      effect: write
      questions:
      - How do I get alerted when my agent starts failing?
      - Can an alarm auto-diagnose the problem when it fires?
      - Is there a cooldown so an alarm doesn't notify me repeatedly?
      instructions:
      - text: Create an alarm on {resource_type} {resource_id} with condition {condition_config}, notifying {channels}.
        slots:
          resource_type: path.resource_type
          resource_id: path.resource_id
          condition_config: requestBody.condition_config
          channels: requestBody.channels
      - text: Set up alarm {name} on agent {resource_id} from source {source_config} with a {cooldown_minutes} minute cooldown.
        slots:
          name: requestBody.name
          resource_id: path.resource_id
          source_config: requestBody.source_config
          cooldown_minutes: requestBody.cooldown_minutes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/alarms/{resource_type}/{resource_id}/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List alarms for an agent or workforce
      effect: read
      questions:
      - What alarms are configured on my workforce?
      - Can I page through all of an agent's alarms?
      instructions:
      - text: List alarms on {resource_type} {resource_id}.
        slots:
          resource_type: path.resource_type
          resource_id: path.resource_id
      - text: Show page {page} of alarms for agent {resource_id}.
        slots:
          page: requestBody.page
          resource_id: path.resource_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/alarms/{resource_type}/{resource_id}/{alarm_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an alarm's settings
      effect: read
      questions:
      - What condition and channels does a particular alarm use?
      - Is a specific alarm currently enabled?
      instructions:
      - text: Get alarm {alarm_id} on {resource_type} {resource_id}.
        slots:
          alarm_id: path.alarm_id
          resource_type: path.resource_type
          resource_id: path.resource_id
      - text: Show the settings of alarm {alarm_id} for agent {resource_id}.
        slots:
          alarm_id: path.alarm_id
          resource_id: path.resource_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/alarms/{resource_type}/{resource_id}/{alarm_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an alarm
      effect: write
      questions:
      - Can I change the threshold or notification channels of an existing alarm?
      - How would I disable an alarm without deleting it?
      instructions:
      - text: Update alarm {alarm_id} on {resource_type} {resource_id} to condition {condition_config}.
        slots:
          alarm_id: path.alarm_id
          resource_type: path.resource_type
          resource_id: path.resource_id
          condition_config: requestBody.condition_config
      - text: Set alarm {alarm_id} on agent {resource_id} to enabled {enabled} and notify {channels}.
        slots:
          alarm_id: path.alarm_id
          resource_id: path.resource_id
          enabled: requestBody.enabled
          channels: requestBody.channels
      method: generated
      generated: '2026-09-26'
- target: $.paths['/alarms/{resource_type}/{resource_id}/{alarm_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an alarm
      effect: destructive
      questions:
      - How do I delete an alarm I no longer want?
      - Can I permanently remove an alarm from a workforce?
      instructions:
      - text: Delete alarm {alarm_id} on {resource_type} {resource_id}.
        slots:
          alarm_id: path.alarm_id
          resource_type: path.resource_type
          resource_id: path.resource_id
      - text: Remove alarm {alarm_id} from agent {resource_id}.
        slots:
          alarm_id: path.alarm_id
          resource_id: path.resource_id
      method: generated
      generated: '2026-09-26'