Relevance AI · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Relevance AI Endpoints Agents API

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

$.info
$.paths['/agents/{agent_id}/conversations'].delete
$.paths['/agents/{agent_id}/conversations/{conversation_id}'].delete
$.paths['/agents/{agent_id}/tags/upsert'].post
$.paths['/agents/{agent_id}/tags/delete'].post
$.paths['/user_tags/list'].get
$.paths['/user_tags/upsert'].post
$.paths['/user_tags/delete'].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 Agents API
  version: 1.0.0
extends: openapi/relevance-ai-agents-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: 7
- target: $.paths['/agents/{agent_id}/conversations'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several conversations for an agent
      effect: destructive
      questions:
      - Can I bulk-delete a batch of conversations from one agent?
      - How do I clear out multiple old agent conversations at once?
      instructions:
      - text: Delete conversations {conversation_ids} from agent {agent_id}.
        slots:
          conversation_ids: requestBody.conversation_ids
          agent_id: path.agent_id
      - text: Bulk-remove the listed conversations {conversation_ids} for agent {agent_id}.
        slots:
          conversation_ids: requestBody.conversation_ids
          agent_id: path.agent_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/{agent_id}/conversations/{conversation_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a single agent conversation
      effect: destructive
      questions:
      - How do I delete one specific conversation with an agent?
      - Can I remove just a single chat thread from an agent's history?
      instructions:
      - text: Delete conversation {conversation_id} of agent {agent_id}.
        slots:
          conversation_id: path.conversation_id
          agent_id: path.agent_id
      - text: Remove the single chat {conversation_id} from agent {agent_id}'s history.
        slots:
          conversation_id: path.conversation_id
          agent_id: path.agent_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/{agent_id}/tags/upsert'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply a tag to an agent
      effect: write
      questions:
      - Can I label an agent with one of my project tags?
      - How do I attach a tag to a specific agent?
      instructions:
      - text: Tag agent {agent_id} with {tag_id}.
        slots:
          agent_id: path.agent_id
          tag_id: requestBody.tag_id
      - text: Attach tag {tag_id} to agent {agent_id}.
        slots:
          tag_id: requestBody.tag_id
          agent_id: path.agent_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/{agent_id}/tags/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove a tag from an agent
      effect: destructive
      questions:
      - How do I take a tag off an agent without deleting the tag itself?
      - Can I untag a single agent?
      instructions:
      - text: Remove tag {tag_id} from agent {agent_id}.
        slots:
          tag_id: requestBody.tag_id
          agent_id: path.agent_id
      - text: Untag agent {agent_id} by detaching {tag_id}.
        slots:
          agent_id: path.agent_id
          tag_id: requestBody.tag_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user_tags/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List tags in the current project
      effect: read
      questions:
      - What tags exist in my project for organizing agents?
      - Which colours and names have we given our project tags?
      instructions:
      - text: List all tags in this project.
      - text: Show me the project's tag names and colours.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user_tags/upsert'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update a project tag
      effect: write
      questions:
      - Can I create a new coloured tag for grouping agents?
      - How do I rename or recolour an existing project tag?
      instructions:
      - text: Create a project tag named {name} with colour {colour}.
        slots:
          name: requestBody.name
          colour: requestBody.colour
      - text: Rename tag {tag_id} to {name} and set its colour to {colour}.
        slots:
          tag_id: requestBody.tag_id
          name: requestBody.name
          colour: requestBody.colour
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user_tags/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a tag from the project
      effect: destructive
      questions:
      - How do I delete a tag from my project entirely?
      - What happens to a project tag once I delete it?
      instructions:
      - text: Delete project tag {tag_id}.
        slots:
          tag_id: requestBody.tag_id
      - text: Remove the tag {tag_id} from this project altogether.
        slots:
          tag_id: requestBody.tag_id
      method: generated
      generated: '2026-09-26'