Relevance AI · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Relevance AI Endpoints Agent Debug Configs API

5 actions 5 updates phrasing extends openapi/relevance-ai-agent-debug-configs-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['/agent-debug-configs/collections/{collection_id}/items/{document_id}/get'].get
$.paths['/agent-debug-configs/collections/{collection_id}/items/{document_id}'].delete
$.paths['/agent-debug-configs/collections/{collection_id}/list'].post
$.paths['/agent-debug-configs/collections/{collection_id}/items/{document_id}/upsert'].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 Agent Debug Configs API
  version: 1.0.0
extends: openapi/relevance-ai-agent-debug-configs-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['/agent-debug-configs/collections/{collection_id}/items/{document_id}/get'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one agent debug config document
      effect: read
      questions:
      - Can I fetch a single saved agent debug configuration by its document id?
      - Which fields can I select when reading one agent debug config?
      instructions:
      - text: Get agent debug config {document_id} from collection {collection_id}.
        slots:
          document_id: path.document_id
          collection_id: path.collection_id
      - text: Read only {select_fields} of debug config {document_id} in collection {collection_id}.
        slots:
          select_fields: query.select_fields
          document_id: path.document_id
          collection_id: path.collection_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-debug-configs/collections/{collection_id}/items/{document_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an agent debug config document
      effect: destructive
      questions:
      - How do I remove an agent debug configuration I no longer need?
      - Is deleting an agent debug config document permanent?
      instructions:
      - text: Delete agent debug config {document_id} from collection {collection_id}.
        slots:
          document_id: path.document_id
          collection_id: path.collection_id
      - text: Remove the debug config document {document_id} in {collection_id}.
        slots:
          document_id: path.document_id
          collection_id: path.collection_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-debug-configs/collections/{collection_id}/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List agent debug configs in a collection
      effect: read
      questions:
      - What agent debug configurations are stored in a collection?
      - Can I filter and sort the agent debug configs in a collection?
      - Is there cursor paging with after_id when listing debug configs?
      instructions:
      - text: List the agent debug configs in collection {collection_id}.
        slots:
          collection_id: path.collection_id
      - text: Show {page_size} agent debug configs from {collection_id} matching {filters}.
        slots:
          page_size: requestBody.page_size
          collection_id: path.collection_id
          filters: requestBody.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-debug-configs/collections/{collection_id}/items/{document_id}/upsert'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update an agent debug config
      effect: write
      questions:
      - Can I create an agent debug config if it doesn't exist yet?
      - How do I increment or remove fields on a saved agent debug config?
      instructions:
      - text: Upsert agent debug config {document_id} in collection {collection_id} with {data}.
        slots:
          document_id: path.document_id
          collection_id: path.collection_id
          data: requestBody.data
      - text: Remove fields {fields_to_remove} from debug config {document_id} in {collection_id}.
        slots:
          fields_to_remove: requestBody.fields_to_remove
          document_id: path.document_id
          collection_id: path.collection_id
      method: generated
      generated: '2026-09-26'