Relevance AI · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Relevance AI Endpoints Mas API

5 actions 5 updates phrasing extends openapi/relevance-ai-mas-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['/mas/items/{document_id}/get'].get

$.paths['/mas/items/{document_id}'].delete

$.paths['/mas/list'].post

$.paths['/mas/items/{document_id}/upsert'].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 Mas API
  version: 1.0.0
extends: openapi/relevance-ai-mas-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['/mas/items/{document_id}/get'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a multi-agent system record
      effect: read
      questions:
      - How do I look up one multi-agent system by its id?
      - Can I fetch only certain fields of a multi-agent system record?
      instructions:
      - text: Get multi-agent system {document_id}.
        slots:
          document_id: path.document_id
      - text: Show fields {select_fields} of multi-agent system {document_id}.
        slots:
          select_fields: query.select_fields
          document_id: path.document_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mas/items/{document_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a multi-agent system
      effect: destructive
      questions:
      - How do I remove a multi-agent system I no longer need?
      - Is deleting a multi-agent system record permanent?
      instructions:
      - text: Delete multi-agent system {document_id}.
        slots:
          document_id: path.document_id
      - text: Remove the MAS record {document_id} from my project.
        slots:
          document_id: path.document_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mas/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List multi-agent systems
      effect: read
      questions:
      - What multi-agent systems exist in my Relevance AI project?
      - Can I filter and sort my multi-agent systems while paging through them?
      instructions:
      - text: List my multi-agent systems.
      - text: List multi-agent systems matching {query}, {page_size} per page.
        slots:
          query: requestBody.query
          page_size: requestBody.page_size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mas/items/{document_id}/upsert'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update a multi-agent system
      effect: write
      questions:
      - How do I save changes to a multi-agent system definition?
      - Can I create a multi-agent system if the id doesn't exist yet?
      instructions:
      - text: Update multi-agent system {document_id} with {data}.
        slots:
          document_id: path.document_id
          data: requestBody.data
      - text: Upsert MAS {document_id} with {data}, inserting it if missing.
        slots:
          document_id: path.document_id
          data: requestBody.data
      method: generated
      generated: '2026-09-26'